Internacionalizar cadeias de caracteres da interface do usuário

As APIs Java e Javascript permitem internacionalizar cadeias de caracteres nos seguintes tipos de recursos:

Arquivos de código-fonte Java.
Scripts JSP.
Javascript em bibliotecas do lado do cliente ou na fonte de página.
Valores de propriedade do nó JCR usados em caixas de diálogo e propriedades de configuração do componente.

Para obter uma visão geral do processo de internacionalização e localização, consulte Internacionalizar componentes.

Internacionalização de strings no código Java e JSP

O com.day.cq.i18n O pacote Java permite exibir cadeias de caracteres localizadas na interface do usuário. O I18n A classe fornece get método que recupera strings localizadas do dicionário de AEM. O único parâmetro obrigatório do get é o literal de string no idioma inglês. Inglês é o idioma padrão da interface do usuário. O exemplo a seguir localiza a palavra Search:

i18n.get("Search");

A identificação da string no idioma inglês é diferente das estruturas de internacionalização típicas, nas quais uma ID identifica uma string e é usada para referenciar a string no tempo de execução. O uso do literal de string em inglês oferece os seguintes benefícios:

O código é fácil de entender.
A string no idioma padrão está sempre disponível.

Determinar o idioma do usuário

Há duas maneiras de determinar o idioma preferido pelo usuário:

Para usuários autenticados, determine o idioma nas preferências na conta de usuário.
A localidade da página solicitada.

A propriedade language da conta de usuário é o método preferido, pois é mais confiável. No entanto, o usuário deve estar conectado para usar esse método.

Criação do objeto Java I18n

A classe I18n fornece dois construtores. Como você determina o idioma preferencial do usuário determina o construtor a ser usado.

Para apresentar a string no idioma especificado na conta de usuário, use o seguinte construtor (após importar com.day.cq.i18n.I18n):

I18n i18n = new I18n(slingRequest);

O construtor usa o SlingHTTPRequest para recuperar a configuração de idioma do usuário.

Para usar o local da página para determinar o idioma, primeiro é necessário obter o ResourceBundle para o idioma da página solicitada:

Locale pageLang = currentPage.getLanguage(false);
ResourceBundle resourceBundle = slingRequest.getResourceBundle(pageLang);
I18n i18n = new I18n(resourceBundle);

Internacionalizar uma string

Use o get do método I18n para internacionalizar uma string. O único parâmetro obrigatório do get é a string a ser internacionalizada. A cadeia de caracteres corresponde a uma cadeia de caracteres em um dicionário do tradutor. O método get pesquisa a string no dicionário e retorna a tradução para o idioma atual.

O primeiro argumento da get deve cumprir as seguintes regras:

O valor deve ser um literal de string. Uma variável do tipo String não é aceitável.
O literal de string deve ser expresso em uma única linha.
A string diferencia maiúsculas de minúsculas.

i18n.get("Enter a search keyword");

Uso de dicas de tradução

Especifique a dica de tradução da string internacionalizada para distinguir entre strings duplicadas no dicionário. Use o segundo parâmetro opcional da variável get para fornecer a dica de tradução. A dica de tradução deve corresponder exatamente à propriedade Comment do item no dicionário.

Por exemplo, o dicionário contém a string Request duas vezes: uma vez como verbo e outra como substantivo. O código a seguir inclui a dica de tradução como um argumento na get método :

i18n.get("Request","A noun, as in a request for a web page");

Inclusão de variáveis em frases localizadas

Inclua variáveis na string localizada para criar significado contextual em uma frase. Por exemplo, depois de fazer logon em um aplicativo da Web, a página inicial exibe a mensagem "Bem-vindo ao Administrador. Você tem 2 mensagens na sua caixa de entrada." O contexto da página determina o nome do usuário e o número de mensagens.

No dicionário, as variáveis são representadas em sequências de caracteres como índices entre colchetes. Especifique os valores das variáveis como argumentos da variável get método . Os argumentos são colocados após a dica de tradução e os índices correspondem à ordem dos argumentos:

i18n.get("Welcome back {0}. You have {1} messages.", "user name, number of messages", user.getDisplayName(), numItems);

A string internacionalizada e a dica de tradução devem corresponder exatamente à string e ao comentário no dicionário. Você pode omitir a dica de localização fornecendo uma null como o segundo argumento.

Uso do método Get Estático

O I18N classe define um get , que é útil quando é necessário localizar um pequeno número de strings. Além dos parâmetros do get , o método estático requer o SlingHttpRequest ou o ResourceBundle que você está usando, de acordo com a determinação do idioma preferencial do usuário:

Use a preferência de idioma do usuário: Forneça SlingHttpRequest como o primeiro parâmetro.

I18n.get(slingHttpRequest, "Welcome back {}. You have {} messages.", "user name, number of messages", user.getDisplayName(), numItems);
Use o idioma da página: Forneça o ResourceBundle como o primeiro parâmetro.

I18n.get(resourceBundle,"Welcome back {}. You have {} messages.", "user name, number of messages", user.getDisplayName(), numItems);

Internacionalização de strings no código Javascript

A API Javascript permite localizar cadeias de caracteres no cliente. Como com Java e JSP , a API do Javascript permite identificar cadeias de caracteres para localização, fornecer dicas de localização e incluir variáveis nas cadeias de caracteres localizadas.

O granite.utils pasta da biblioteca do cliente O fornece a API do Javascript. Para usar a API, inclua essa pasta da biblioteca de clientes na página. As funções de localização usam o Granite.I18n namespace.

Antes de apresentar cadeias de caracteres localizadas, é necessário definir a localidade usando a variável Granite.I18n.setLocale . A função requer o código de idioma da localidade como um argumento:

Granite.I18n.setLocale("fr");

Para apresentar uma string localizada, use o Granite.I18n.get função:

Granite.I18n.get("string to localize");

O exemplo a seguir internacionaliza a string "Bem-vindo de volta":

Granite.I18n.setLocale("fr");
Granite.I18n.get("string to localize", [variables], "localization hint");

Os parâmetros da função são diferentes do método Java I18n.get:

O primeiro parâmetro é o literal de string a ser localizado.
O segundo parâmetro é uma matriz de valores a serem inseridos no literal de string.
O terceiro parâmetro é a dica de localização.

O exemplo a seguir usa o Javascript para localizar o "Welcome back Administrator". Você tem 2 mensagens na sua caixa de entrada." frase:

Granite.I18n.setLocale("fr");
Granite.I18n.get("Welcome back {0}. You have {1} new messages in your inbox.", [username, numMsg], "user name, number of messages");

Internacionalizar strings a partir de nós JCR

As cadeias de caracteres da interface do usuário geralmente são baseadas nas propriedades do nó JCR. Por exemplo, a variável jcr:title a propriedade de uma página normalmente é usada como o conteúdo da variável h1 no código da página. O I18n A classe fornece getVar para localizar essas cadeias de caracteres.

O exemplo de script JSP a seguir recupera o jcr:title propriedade do repositório e exibe a string localizada na página :

<% title = properties.get("jcr:title", String.class);%>
<h1><%=i18n.getVar(title) %></h1>

Especificação de dicas de tradução para nós JCR

Semelhante a dicas de tradução na API do Java, você pode fornecer dicas de tradução para distinguir cadeias de caracteres duplicadas no dicionário. Forneça a dica de tradução como uma propriedade do nó que contém a propriedade internacionalizada. O nome da propriedade de dica é composto do nome da propriedade internacionalizada com a variável _commentI18n sufixo:

${prop}_commentI18n

Por exemplo, um cq:page O nó inclui a propriedade jcr:title que está sendo localizada. A dica é fornecida como o valor da propriedade chamada jcr:title_commentI18n.

Teste da cobertura da internacionalização

Teste se você internacionalizou todas as strings na sua interface do usuário. Para ver quais strings são abordadas, defina o idioma do usuário como zz_ZZ e abra a interface do usuário no navegador da Web. As cadeias de caracteres internacionalizadas aparecem com uma tradução stub no seguinte formato:

USR_*Default-String*_尠

A imagem a seguir mostra a tradução de stub da página inicial da AEM:

chlimage_1