Chaves são usadas para identificar strings de texto traduzíveis dentro do código de software. Isso permite que o uso de uma chave (como um nome de código para uma string traduzível) seja referenciado apenas uma vez pelo Phrase, em vez de para cada tradução necessária da string.
Uma chave pode ter várias traduções associadas a ela, cada uma correspondendo a um idioma e localidade diferente do projeto. A função é semelhante à da chave primária em bancos de dados relacionais, com as traduções sendo um atributo da chave. As chaves são armazenadas em arquivos de recursos e são usadas para identificar os idiomas de origem e de destino.
O uso de chaves permite que plataformas de gerenciamento de localização apresentem texto traduzível aos tradutores sem precisar apresentar código.
As chaves normalmente não precisam ser adicionadas a um projeto, pois são idealmente criadas quando um arquivo de recurso é enviado através da guia de uma página de projeto.
Para evitar que chaves sejam enviadas ou criadas, use a funcionalidade bloqueio de chave. Se uma chave bloqueada já existir, ela não poderá ser traduzida no editor.
Para excluir chaves da exportação, use a funcionalidade excluir chaves. Chaves excluídas também não podem ser traduzidas no editor.
As chaves em um projeto podem ser duplicadas selecionando Mais/Duplicar chave na seção de uma página de projeto ou na parte superior do painel do editor de Strings.
Diferentes chaves de tradução com os mesmos valores em um ou vários projetos podem ser vinculadas para automatizar atualizações de conteúdo. Chaves vinculadas são usadas para garantir a consistência entre projetos e eliminar o trabalho repetitivo em conteúdo idêntico.
Alterações nas chaves podem ser revertidas a partir da janela de atividade da barra lateral no editor de Strings.
Nota
Ao trabalhar com repositórios (GitHub, GitLab, etc.) e excluir chaves, as chaves devem ser excluídas tanto do Phrase quanto do repositório para serem excluídas permanentemente. Isso serve para evitar a exclusão acidental de chaves devido a erros ou acidentes no Phrase ou no repositório.
No Strings, as chaves podem ser de diferentes tipos, dependendo do formato do arquivo enviado:
-
String (padrão)
Nota
Tradutores só podem editar chaves de string a menos que a opção esteja habilitada nas configurações avançadas de projeto.
-
Matriz
-
Booleano
-
Markdown
-
Número
O tipo de chave é exibido na seção da barra lateral do editor.
Os nomes das chaves devem ser únicos dentro de um projeto.
Existem várias estratégias para nomear chaves:
-
Descritiva
O texto original é identificado pela função. Isso pode tornar mais difícil identificar o texto ao ler o código, mas permanecerá constante.
Exemplo:
-
Strings de origem (não recomendado)
O texto original em si é usado como a chave, o que torna fácil identificar o uso do texto. Isso é problemático, pois se o texto original mudar, a relação com as traduções é quebrada.
Exemplo:
Se as chaves não forem carregadas, elas podem ser criadas manualmente.
Para criar uma chave, siga estas etapas:
-
Na guia , clique em Adicionar chave.
A janela Adicionar chave é aberta.
-
Na guia , forneça um , , quaisquer disponíveis e uma .
-
Se necessário, habilite formas plurais na guia e escolha o tipo de forma plural.
-
Selecione os idiomas excluídos na guia , se necessário.
-
Forneça detalhes técnicos na guia , se necessário.
Por exemplo, é possível definir um limite de caracteres para traduções no campo Caracteres. Se definido, o limite de caracteres é exibido por um indicador no Editor de Strings ao editar as traduções da chave relevante.
-
Clique em Gravar.
A chave é adicionada ao projeto e pode ser visualizada na guia .
Excluir uma chave do editor ou da guia excluirá todas as traduções associadas a essa chave e não poderá ser revertida.
Em projetos com mais de 10.000 chaves, as chaves não mencionadas não serão calculadas em uploads futuros. Chaves não mencionadas são chaves que não estão incluídas no upload atual, mas ainda existem no projeto.
O bloqueio impede que chaves inteiras sejam adicionadas a um projeto; se o nome de uma chave bloqueada aparecer em um arquivo enviado, essa chave será omitida e não adicionada ao projeto.
O bloqueio é usado para omitir chaves de um projeto para que elas não sejam gerenciadas de forma alguma.
Normalmente, as chaves bloqueadas:
-
Strings de formato de data e hora.
-
Chaves incluindo as configurações.
-
Chaves que causam problemas quando gerenciadas com a gem Phrase.
Gerencie chaves bloqueadas em um arquivo de idioma separado que não é processado ou mantido.
Essas chaves podem causar problemas e, se usadas, devem ser bloqueadas quando um projeto é criado.
-
activemodel.errors* -
number.format* -
number.currency* -
number.percentage* -
datetime.prompts*
Para bloquear uma chave, siga estas etapas:
-
Em uma página de projeto, selecione a guia .
-
Clique em Adicionar chave à lista de chaves bloqueadas.
A janela é aberta.
-
Forneça um nome para a chave ou uma expressão regular (regex) e clique em Salvar.
A chave é adicionada à lista.
Dica
Chatbots de IA podem ser muito eficazes na geração e verificação de regex.
Use ferramentas como o Regex101 para testar regex com as diferentes entradas.
As chaves podem ser modificadas posteriormente clicando em ou excluídas
.
Algumas chaves podem precisar ser excluídas de certos idiomas e podem ser marcadas como excluídas. Essas chaves são carregadas e existem dentro de um projeto, mas são ignoradas.
As traduções excluídas são:
-
Excluído da exportação do idioma relacionado.
-
Excluído dos relatórios do idioma relacionado.
Se o conteúdo estiver vazio, ele não é contabilizado como não traduzido.
-
Visível, mas não editável no editor de tradução.
As traduções excluídas são omitidas das contagens de traduzidos/não traduzidos e dos relatórios de idioma. Como resultado, um projeto ou localidade pode mostrar 0 strings não traduzidas mesmo quando as traduções excluídas ainda não possuem uma tradução real. Isso inclui conteúdo em branco ou uma cópia não traduzida do texto original. Para confirmar se um projeto está realmente completo, verifique a aba ou consulte as traduções com excluded:true via API, além da contagem de não traduzidos.
Opções de exclusão:
-
Exclua uma única tradução em um idioma dentro do editor de tradução.
-
Exclua várias traduções em um idioma dentro do editor de tradução.
-
Exclua várias traduções selecionando os idiomas ao criar ou editar a chave.
Para excluir uma chave, siga estas etapas:
-
Na página de chaves, clique em
para a chave que requer exclusão.
A janela é aberta.
-
Selecione a guia .
-
Selecione os idiomas para exclusão.
-
Clique em Gravar.
A seleção é excluída na chave especificada.
As chaves também podem ser excluídas individualmente ou em massa da lista de chaves do editor selecionando a(s) chave(s) e usando o menu .