Internacionalización de cadenas de IU

Las API de Java™ y JavaScript permiten internacionalizar cadenas en los siguientes tipos de recursos:

• Archivos de origen Java™.
• Scripts JSP.
• JavaScript en bibliotecas del lado del cliente o en origen de página.
• Valores de propiedad del nodo JCR utilizados en cuadros de diálogo y propiedades de configuración de componentes.

Para ver una descripción general del proceso de internacionalización y localización, consulte Internacionalización de componentes.

Internacionalización de cadenas en código Java™ y JSP

El com.day.cq.i18n El paquete Java™ le permite mostrar cadenas localizadas en la interfaz de usuario. El I18n proporciona la clase get método que recupera cadenas localizadas del diccionario de Adobe Experience Manager AEM (). El único parámetro requerido del get El método es el literal de cadena en inglés. El idioma predeterminado de la interfaz de usuario es inglés. En el siguiente ejemplo, se localiza la palabra Search:

i18n.get("Search");

La identificación de la cadena en inglés difiere de los marcos de internacionalización típicos en los que un ID identifica una cadena y se utiliza para hacer referencia a la cadena durante la ejecución. El uso del literal de cadena en inglés ofrece las siguientes ventajas:

• El código es fácil de entender.
• La cadena en el idioma predeterminado siempre está disponible.

Determinación del idioma del usuario

Existen dos formas de determinar el idioma que prefiere el usuario:

• Para los usuarios autenticados, determine el idioma a partir de las preferencias de la cuenta de usuario.
• La configuración regional de la página solicitada.

La propiedad language de la cuenta de usuario es el método preferido porque es más confiable. Sin embargo, el usuario debe haber iniciado sesión para utilizar este método.

Creación del objeto Java™ I18n

La clase I18n proporciona dos constructores. La forma de determinar el idioma preferido del usuario determina el constructor que se va a utilizar.

Para presentar la cadena en el idioma especificado en la cuenta de usuario, utilice el siguiente constructor (después de importar com.day.cq.i18n.I18n):

I18n i18n = new I18n(slingRequest);

El constructor utiliza el SlingHTTPRequest para recuperar la configuración de idioma del usuario.

Para utilizar la configuración regional de la página para determinar el idioma, obtenga primero el ResourceBundle del idioma de la página solicitada:

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

Internacionalización de una cadena

Utilice el get método del I18n para internacionalizar una cadena. El único parámetro requerido del get El método es la cadena que se va a internacionalizar. La cadena corresponde a una cadena en un diccionario de Translator. El método get busca la cadena en el diccionario y devuelve la traducción del idioma actual.

El primer argumento del get El método debe cumplir las siguientes reglas:

• El valor debe ser un literal de cadena. Una variable de tipo String no es aceptable.
• El literal de cadena debe expresarse en una sola línea.
• La cadena distingue entre mayúsculas y minúsculas.

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

Uso de sugerencias de traducción

Especifique el sugerencia de traducción de la cadena internacionalizada para distinguir entre cadenas duplicadas en el diccionario. Utilice el segundo parámetro opcional del get para proporcionar la sugerencia de traducción. La sugerencia de traducción debe coincidir exactamente con la propiedad Comment del elemento del diccionario.

Por ejemplo, el diccionario contiene la cadena Request dos veces: una vez como verbo y otra como sustantivo. El siguiente código incluye la sugerencia de traducción como un argumento en la variable get método:

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

Inclusión de variables en frases localizadas

Incluya variables en la cadena localizada para crear significado contextual en una frase. Por ejemplo, después de iniciar sesión en una aplicación web, la página de inicio muestra el mensaje "Bienvenido de nuevo, administrador". Tiene dos mensajes en la bandeja de entrada". El contexto de página determina el nombre de usuario y el número de mensajes.

En el diccionario, las variables se representan en cadenas como índices entre corchetes. Especifique los valores de las variables como argumentos de la variable get método. Los argumentos se colocan después de la sugerencia de traducción y los índices se corresponden con el orden de los argumentos:

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

La cadena internacionalizada y la sugerencia de traducción deben coincidir exactamente con la cadena y el comentario del diccionario. Puede omitir la sugerencia de localización proporcionando un null valor como segundo argumento.

Uso del método Get estático

El I18N define una clase estática get que resulta útil cuando se deben localizar unas pocas cadenas. Además de los parámetros de un objeto get método, el método estático requiere lo siguiente SlingHttpRequest objeto o el ResourceBundle que utilice, según cómo vaya a determinar el idioma preferido del usuario:

• Utilice la preferencia de idioma del usuario: Proporcione SlingHttpRequest como el primer parámetro.

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

• Utilice el idioma de la página: Proporcione el ResourceBundle como primer parámetro.

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

Internacionalización de cadenas en código JavaScript

La API de JavaScript permite localizar cadenas en el cliente. Al igual que con Java™ y JSP , la API de JavaScript permite identificar cadenas para localizar, proporcionar sugerencias de localización e incluir variables en las cadenas localizadas.

El granite.utils carpeta de biblioteca de cliente proporciona la API de JavaScript. Para utilizar la API, incluya esta carpeta de biblioteca de cliente en su página. Las funciones de localización utilizan Granite.I18n namespace.

Antes de presentar cadenas localizadas, establezca la configuración regional utilizando Granite.I18n.setLocale función. La función requiere el código de idioma de la configuración regional como argumento:

Granite.I18n.setLocale("fr");

Para presentar una cadena localizada, utilice el Granite.I18n.get función:

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

El siguiente ejemplo internacionaliza la cadena "Bienvenido de nuevo":

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

Los parámetros de función son diferentes del método Java™ I18n.get:

• El primer parámetro es el literal de cadena que se va a localizar.
• El segundo parámetro es una matriz de valores que se van a insertar en el literal de cadena.
• El tercer parámetro es la sugerencia de localización.

El siguiente ejemplo utiliza JavaScript para localizar el administrador de bienvenida. Tiene dos mensajes en la bandeja 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");

Internacionalización de cadenas de nodos JCR

Las cadenas de interfaz de usuario suelen basarse en las propiedades del nodo JCR. Por ejemplo, la variable jcr:title La propiedad de una página se suele utilizar como contenido del h1 en el código de página. El I18n proporciona la clase getVar para localizar estas cadenas.

El siguiente ejemplo de script JSP recupera la variable jcr:title del repositorio y muestra la cadena localizada en la página:

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

Especificar sugerencias de traducción para nodos JCR

Similar a sugerencias de traducción en la API de Java™, puede proporcionar sugerencias de traducción para distinguir cadenas duplicadas en el diccionario. Proporcione la sugerencia de traducción como una propiedad del nodo que contiene la propiedad internacionalizada. El nombre de la propiedad hint está compuesto por el nombre de la propiedad internacionalizada con el nombre _commentI18n sufijo:

${prop}_commentI18n

Por ejemplo, una cq:page El nodo incluye la propiedad jcr:title que se está localizando. La sugerencia se proporciona como el valor de la propiedad denominada jcr:title_commentI18n.

Prueba de cobertura de internacionalización

Compruebe si ha internacionalizado todas las cadenas de la interfaz de usuario. Para ver qué cadenas están cubiertas, establezca el idioma del usuario en zz_ZZ y abra la interfaz de usuario en el explorador web. Las cadenas internacionalizadas aparecen con una traducción de código auxiliar en el siguiente formato:

USR_*Default-String*_尠

AEM La siguiente imagen muestra la traducción de código auxiliar de la página de inicio de la:

Para establecer el idioma del usuario, configure la propiedad language del nodo de preferencias de la cuenta de usuario.

El nodo de preferencias de un usuario tiene una ruta como esta:

/home/users/<letter>/<hash>/preferences