chrome.i18n

Descripción

Manifiesto

Si una extensión tiene un directorio /_locales, el manifiesto debe definir "default_locale".

Conceptos y uso

Debes colocar todas sus cadenas visibles para el usuario en un archivo llamado messages.json. Cada vez que agregas una configuración regional nueva, agregas un archivo de mensajes en un directorio llamado /_locales/_localeCode_, en el que localeCode es un código como en para inglés.

Esta es la jerarquía de archivos de una extensión internacionalizada que admite inglés (en), español (es) y coreano (ko):

Compatibilidad con varios idiomas

Supongamos que tienes una extensión con los archivos que se muestran en la siguiente imagen:

Para internacionalizar esta extensión, asigna un nombre a cada cadena visible para el usuario y colócala en un archivo de mensajes. El manifiesto, los archivos CSS y el código JavaScript de la extensión usan el nombre de cada cadena para obtener su versión localizada.

Así es como se ve la extensión cuando está internacionalizada (ten en cuenta que todavía solo tiene cadenas en inglés):

Algunas notas sobre la internacionalización:

• Puedes usar cualquiera de las configuraciones regionales compatibles. Si usas una configuración regional no compatible, Google Chrome la ignorará.

• En los archivos manifest.json y CSS, haz referencia a una cadena llamada messagename de la siguiente manera:

  __MSG_messagename__
  

• En el código JavaScript de tu extensión o app, haz referencia a una cadena llamada messagename de la siguiente manera:

  chrome.i18n.getMessage("messagename")
  

• En cada llamada a getMessage(), puedes proporcionar hasta 9 cadenas para que se incluyan en el mensaje. Consulta Ejemplos: getMessage para obtener más detalles.

• El sistema de internacionalización proporciona algunos mensajes, como @@bidi_dir y @@ui_locale. Consulta la sección Mensajes predefinidos para obtener una lista completa de los nombres de los mensajes predefinidos.

• En messages.json, cada cadena visible para el usuario tiene un nombre, un elemento “message” y un elemento “description” opcional. El nombre es una clave, como "extName" o "search_string", que identifica la cadena. En "message", se especifica el valor de la cadena en esta configuración regional. La "descripción" opcional proporciona ayuda a los traductores, que podrían no poder ver cómo se usa la cadena en tu extensión. Por ejemplo:

  {
    "search_string": {
      "message": "hello%20world",
      "description": "The string we search for. Put %20 between words that go together."
    },
    ...
  }
  

Para obtener más información, consulta Formatos: Mensajes específicos de la configuración regional.

Una vez que se internacionaliza una extensión, traducirla es sencillo. Copias messages.json, la traduces y la colocas en un directorio nuevo en /_locales. Por ejemplo, para admitir español, solo coloca una copia traducida de messages.json en /_locales/es. En la siguiente imagen, se muestra la extensión anterior con una nueva traducción al español.

Mensajes predefinidos

El sistema de internacionalización proporciona algunos mensajes predefinidos para ayudarte con la localización. Estos incluyen @@ui_locale, para que puedas detectar la configuración regional actual de la IU, y algunos mensajes @@bidi_... que te permiten detectar la dirección del texto. Los últimos mensajes tienen nombres similares a las constantes de la API de BIDI (bidireccional) de gadgets.

El mensaje especial @@extension_id se puede usar en los archivos CSS y JavaScript, independientemente de si la extensión o la app están localizadas. Este mensaje no funciona en los archivos de manifiesto.

En la siguiente tabla, se describe cada mensaje predefinido.

A continuación, se muestra un ejemplo del uso de @@extension_id en un archivo CSS para crear una URL:

body {
  background-image:url('chrome-extension://__MSG_@@extension_id__/background.png');
}

Si el ID de extensión es abcdefghijklmnopqrstuvwxyzabcdef, la línea en negrita del fragmento de código anterior se convierte en lo siguiente:

  background-image:url('chrome-extension://abcdefghijklmnopqrstuvwxyzabcdef/background.png');

Este es un ejemplo del uso de mensajes @@bidi_* en un archivo CSS:

body {
  direction: __MSG_@@bidi_dir__;
}

div#header {
  margin-bottom: 1.05em;
  overflow: hidden;
  padding-bottom: 1.5em;
  padding-__MSG_@@bidi_start_edge__: 0;
  padding-__MSG_@@bidi_end_edge__: 1.5em;
  position: relative;
}

En el caso de los idiomas de izquierda a derecha, como el inglés, las líneas en negrita se convierten en lo siguiente:

  dir: ltr;
  padding-left: 0;
  padding-right: 1.5em;

Configuraciones regionales

Puedes elegir entre muchas configuraciones regionales, incluidas algunas (como en) que permiten que una sola traducción admita varias variaciones de un idioma (como en_GB y en_US).

Puedes localizar tu extensión a cualquier configuración regional que admita Chrome Web Store. Si tu configuración regional no aparece en la lista, elige la alternativa más cercana. Por ejemplo, si la configuración regional predeterminada de tu extensión es "de_CH", elige "de" en Chrome Web Store.

Buscar mensajes

No es necesario que definas todas las cadenas para cada configuración regional admitida. Siempre que el archivo messages.json de la configuración regional predeterminada tenga un valor para cada cadena, tu extensión o app se ejecutará sin importar cuán escasa sea una traducción. A continuación, se muestra cómo el sistema de extensiones busca un mensaje:

1. Busca la configuración regional preferida del usuario en el archivo de mensajes (si corresponde). Por ejemplo, cuando la configuración regional de Google Chrome está establecida en inglés británico (en_GB), el sistema primero busca el mensaje en /_locales/en_GB/messages.json. Si ese archivo existe y el mensaje está allí, el sistema no busca más.
2. Si la configuración regional preferida del usuario tiene una región (es decir, la configuración regional tiene un guion bajo: _), busca la configuración regional sin esa región. Por ejemplo, si el archivo de mensajes en_GB no existe o no contiene el mensaje, el sistema busca en el archivo de mensajes en. Si ese archivo existe y el mensaje está allí, el sistema no busca más.
3. Busca la configuración regional predeterminada en el archivo de mensajes. Por ejemplo, si el valor de "default_locale" de la extensión está configurado en "es" y ni /_locales/en_GB/messages.json ni /_locales/en/messages.json contienen el mensaje, la extensión usará el mensaje de /_locales/es/messages.json.

En la siguiente imagen, el mensaje llamado "colores" está en las tres configuraciones regionales que admite la extensión, pero "extName" solo está en dos de ellas. Cuando un usuario que ejecuta Google Chrome en inglés de EE.UU. ve la etiqueta "Colores", un usuario de inglés británico ve "Colours". Los usuarios de inglés británico y estadounidense ven el nombre de la extensión "Hello World". Como el idioma predeterminado es el español, los usuarios que ejecutan Google Chrome en cualquier idioma que no sea inglés ven la etiqueta "Colores" y el nombre de la extensión "Hola mundo".

Establece la configuración regional de tu navegador

Para probar las traducciones, te recomendamos que configures la configuración regional de tu navegador. En esta sección, se explica cómo configurar la configuración regional en Windows, Mac OS, Linux y ChromeOS.

Windows

Puedes cambiar la configuración regional con una combinación de teclas específica de la configuración regional o la IU de Google Chrome. El enfoque de acceso directo es más rápido, una vez que lo configuras, y te permite usar varios idiomas a la vez.

Usa una combinación de teclas específica de la configuración regional

Para crear y usar un atajo que inicie Google Chrome con una configuración regional en particular, haz lo siguiente:

1. Crea una copia del atajo de Google Chrome que ya está en tu escritorio.
2. Cambia el nombre del nuevo atajo para que coincida con la nueva configuración regional.

3. Cambia las propiedades del atajo para que el campo Target especifique las marcas --lang y --user-data-dir. El objetivo debería verse de la siguiente manera:

   path_to_chrome.exe --lang=locale --user-data-dir=c:\locale_profile_dir
   

4. Haz doble clic en el acceso directo para iniciar Google Chrome.

Por ejemplo, para crear un acceso directo que inicie Google Chrome en español (es), puedes crear un acceso directo llamado chrome-es que tenga el siguiente destino:

path_to_chrome.exe --lang=es --user-data-dir=c:\chrome-profile-es

Puedes crear tantos atajos como quieras, lo que facilita las pruebas en varios idiomas. Por ejemplo:

path_to_chrome.exe --lang=en --user-data-dir=c:\chrome-profile-en
path_to_chrome.exe --lang=en_GB --user-data-dir=c:\chrome-profile-en_GB
path_to_chrome.exe --lang=ko --user-data-dir=c:\chrome-profile-ko

Cómo usar la IU

Sigue estos pasos para cambiar la configuración regional con la IU de Google Chrome para Windows:

1. Ícono de la app > Opciones
2. Elige la pestaña Detalles.
3. Desplázate hasta Contenido web.
4. Haz clic en Cambiar la configuración de idioma y fuente.
5. Elige la pestaña Idiomas.
6. Usa el menú desplegable para establecer el idioma de Google Chrome.
7. Reinicia Chrome

macOS

Para cambiar la configuración regional en Mac, usa las preferencias del sistema.

1. En el menú de Apple, elige Preferencias del sistema.
2. En la sección Personal, elige Internacional.
3. Elige tu idioma y ubicación
4. Reinicia Chrome

Linux

Para cambiar la configuración regional en Linux, primero sal de Google Chrome. Luego, en una sola línea, establece la variable de entorno LANGUAGE y, luego, inicia Google Chrome. Por ejemplo:

LANGUAGE=es ./chrome

ChromeOS

Para cambiar la configuración regional en ChromeOS, haz lo siguiente:

1. En la bandeja del sistema, elige Configuración.
2. En la sección Idiomas y entrada, elige el menú desplegable Idioma.
3. Si tu idioma no aparece en la lista, haz clic en Agregar idiomas y agrégalo.
4. Una vez que lo hagas, haz clic en el elemento de menú de 3 puntos Más acciones junto a tu idioma y elige Mostrar ChromeOS en este idioma.
5. Haz clic en el botón Reiniciar que aparece junto al idioma establecido para reiniciar ChromeOS.

Ejemplos

Puedes encontrar ejemplos de internacionalización en el directorio examples/api/i18n. Para ver un ejemplo completo, consulta examples/extensions/news. Para ver otros ejemplos y obtener ayuda para ver el código fuente, consulta Muestras.

getMessage()

El siguiente código obtiene un mensaje localizado del navegador y lo muestra como una cadena. Reemplaza dos marcadores de posición dentro del mensaje por las cadenas "cadena1" y "cadena2".

function getMessage() {
  var message = chrome.i18n.getMessage("click_here", ["string1", "string2"]);
  document.getElementById("languageSpan").innerHTML = message;
}

A continuación, se muestra cómo proporcionar y usar una sola cadena:

  // In JavaScript code
  status.innerText = chrome.i18n.getMessage("error", errorDetails);

"error": {
  "message": "Error: $details$",
  "description": "Generic error template. Expects error parameter to be passed in.",
  "placeholders": {
    "details": {
      "content": "$1",
      "example": "Failed to fetch RSS feed."
    }
  }
}

Para obtener más información sobre los marcadores de posición, consulta la página Mensajes específicos de la configuración regional. Para obtener detalles sobre cómo llamar a getMessage(), consulta la referencia de la API.

getAcceptLanguages()

En el siguiente código, se obtienen los idiomas aceptados del navegador y se muestran como una cadena, ya que se separa cada idioma aceptado con ','.

function getAcceptLanguages() {
  chrome.i18n.getAcceptLanguages(function(languageList) {
    var languages = languageList.join(",");
    document.getElementById("languageSpan").innerHTML = languages;
  })
}

Para obtener detalles sobre cómo llamar a getAcceptLanguages(), consulta la referencia de la API.

detectLanguage()

El siguiente código detecta hasta 3 idiomas de la cadena determinada y muestra el resultado como cadenas separadas por líneas nuevas.

function detectLanguage(inputText) {
  chrome.i18n.detectLanguage(inputText, function(result) {
    var outputLang = "Detected Language: ";
    var outputPercent = "Language Percentage: ";
    for(i = 0; i < result.languages.length; i++) {
      outputLang += result.languages[i].language + " ";
      outputPercent +=result.languages[i].percentage + " ";
    }
    document.getElementById("languageSpan").innerHTML = outputLang + "\n" + outputPercent + "\nReliable: " + result.isReliable;
  });
}

Para obtener más detalles sobre cómo llamar a detectLanguage(inputText), consulta la referencia de la API.

chrome.i18n.detectLanguage(
  text: string,
  callback?: function,
)

chrome.i18n.getAcceptLanguages(
  callback?: function,
)

chrome.i18n.getMessage(
  messageName: string,
  substitutions?: any,
  options?: object,
)

chrome.i18n.getUILanguage()