As 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 correspondente a um idioma local diferente do projeto. A função é semelhante à do 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 idiomas de origem e destino.
O uso de chaves permite que plataformas de gerenciamento de localização apresentem texto traduzível aos tradutores sem ter que apresentar o 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 aba de uma página de projeto.
Para evitar que chaves sejam enviadas ou criadas, use a funcionalidade de chave de bloqueio. Se uma chave bloqueada já existir, ela não pode ser traduzida no editor.
Para excluir chaves da exportação, use a funcionalidade de excluir chaves. Chaves excluídas também não podem ser traduzidas no editor.
Chaves em um projeto podem ser duplicadas selecionando Mais/Duplicar chave na seção de uma página de projeto ou no topo do painel do editor de Strings.
Chaves de tradução diferentes 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 consistência entre projetos e eliminar trabalho repetitivo em conteúdo idêntico.
Mudanças nas chaves podem ser revertidas na janela de atividade 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 é para evitar a exclusão acidental de chaves devido a erros ou acidentes no Phrase ou no repositório.
Em Strings, as chaves podem ser de diferentes tipos dependendo do formato do arquivo enviado:
-
String (padrão)
Nota
Os tradutores só podem editar chaves de string, a menos que a projeto.
opção esteja ativada nas configurações avançadas do -
Matriz
-
Booleano
-
Markdown
-
Número
O tipo de chave é exibido na seção barra lateral do editor.
daOs nomes das chaves devem ser únicos dentro de um projeto.
Existem várias estratégias para nomear chaves:
-
Descritivo
O texto original é identificado pela função. Isso pode dificultar a identificação do texto ao ler o código, mas permanecerá uma constante.
Exemplo:
-
Strings de origem (não recomendado)
O texto original em si é usado como a chave, o que facilita a identificação do uso do texto. Isso é problemático, pois se o texto original mudar, quebra a relação com as traduções.
Exemplo:
Se as chaves não forem enviadas, elas podem ser criadas manualmente.
Para criar uma chave, siga estas etapas:
-
Na aba Adicionar chave.
, clique emA janela Adicionar chave é aberta.
-
Na aba
, forneça um , , quaisquer disponíveis e uma . -
Se necessário, ative formas plurais na aba e escolha o tipo de forma plural.
-
Selecione idiomas excluídos na aba
se necessário. -
Forneça detalhes técnicos na aba
se necessário.Por exemplo, é possível definir um limite de caracteres para traduções no campo
-
Clique em Gravar.
Excluir uma chave do editor ou da aba
excluirá todas as traduções associadas a essa chave e não pode ser revertido.
Em projetos com mais de 10.000 chaves, chaves não mencionadas não serão calculadas em envios futuros.
Chaves não mencionadas são chaves que não estão incluídas no envio atual, mas ainda existem no projeto. Chaves Bloqueadas
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 é omitida e não é adicionada ao projeto.
O bloqueio é usado para omitir chaves de um projeto para que não sejam gerenciadas de forma alguma.
Chaves tipicamente bloqueadas:
-
Strings de formato de data e hora.
-
Chaves incluindo configurações.
-
Chaves que causam problemas quando gerenciadas com o 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*
-
número.moeda*
-
number.percentage*
-
datetime.prompts*
Para bloquear uma chave, siga estas etapas:
-
Na página do projeto, selecione a aba
. -
Clique em Adicionar chave à lista de chaves bloqueadas.
A janela
se abre. -
Forneça um nome para a chave ou uma expressão regular (regex) e clique em Gravar.
A chave é adicionada à lista.
Dica
Chatbots de IA podem ser muito eficazes na geração e verificação de regex.
Use ferramentas como Regex101 para testar regex com 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.
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, não é contado como não traduzido.
-
Visível, mas não editável no editor de tradução.
Opções de exclusão:
-
Excluir uma única tradução em um idioma dentro do editor de tradução.
-
Excluir várias traduções em um idioma dentro do editor de tradução.
-
Excluir 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 aba
. -
Selecione 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 .