Cada extensión o app internacionalizada tiene al menos un archivo llamado messages.json que proporciona
específicas de la configuración regional. En esta página, se describe el formato de los archivos messages.json. Para obtener información sobre cómo internacionalizar y localizar, consulta la página Internacionalización.
Resumen de campos
En el siguiente código, se muestran los campos compatibles para messages.json. Solo el campo "name" y "mensaje"
Los campos son obligatorios.
{
"name": {
"message": "Message text, with optional placeholders.",
"description": "Translator-aimed description of the message.",
"placeholders": {
"placeholder_name": {
"content": "A string to be placed within the message.",
"example": "Translator-aimed example of the placeholder string."
},
...
}
},
...
}
Ejemplo
Este es un archivo messages.json que define tres mensajes llamados "prompt_for_name", "hello" y "bye":
{
"prompt_for_name": {
"message": "What's your name?",
"description": "Ask for the user's name"
},
"hello": {
"message": "Hello, $USER$",
"description": "Greet the user",
"placeholders": {
"user": {
"content": "$1",
"example": "Cira"
}
}
},
"bye": {
"message": "Goodbye, $USER$. Come back to $OUR_SITE$ soon!",
"description": "Say goodbye to the user",
"placeholders": {
"our_site": {
"content": "Example.com",
},
"user": {
"content": "$1",
"example": "Cira"
}
}
}
}
Detalles del campo
En esta sección, se describe cada campo que puede aparecer en un archivo messages.json. Para obtener detalles sobre cómo
de mensajes de Google (por ejemplo, qué sucede cuando una configuración regional no define todos los mensajes), consulta
Internacionalización.
nombre
De hecho, no hay ningún campo llamado "name". El nombre de este campo es el nombre del mensaje; el mismo
name que ves en __MSG__name___ o getMessage("_name_").
El nombre es una clave que no distingue mayúsculas de minúsculas y que te permite recuperar el texto del mensaje localizado. El nombre solo incluya los siguientes caracteres:
- A-Z
- a-z
- 0-9
- _ (guion bajo)
- @
Estos son tres ejemplos de nombres, tomados de la sección Ejemplo:
"prompt_for_name": {
...
},
"hello": {
...
},
"bye": {
...
}
Para obtener más ejemplos de uso de nombres, consulta la página Internacionalización.
mensaje
El mensaje traducido, en forma de una cadena que puede contener marcadores de posición. Usa $_placeholder_name_$ (sin distinción entre mayúsculas y minúsculas) para hacer referencia a un marcador de posición en particular. Por ejemplo, puedes
hacer referencia a un marcador de posición llamado "our_site" como $our_site$, $OUR_SITE$ o $oUR_sITe$.
Aquí hay tres ejemplos de mensajes extraídos de la sección Ejemplo:
"message": "What's your name?"
...
"message": "Hello, $USER$"
...
"message": "Goodbye, $USER$. Come back to $OUR_SITE$ soon!"
Para colocar un signo de dólar ($) en la cadena, usa $$. For example, use the following code to specify
the message Amount (in $):
"message": "Amount (in $$)".Aunque los marcadores de posición, como
$USER$, son la forma preferida de hacer referencia a las cadenas de sustitución (cadenas especificadas con el parámetro substitutions de i18n.getMessage), también puedes hacer referencia a las cadenas de sustitución directamente dentro del mensaje. Por ejemplo, el siguiente mensaje se refiere a las tres primeras strings de sustitución que se pasaron agetMessage():"message": "Params: $1, $2, $3"A pesar de ese ejemplo, te recomendamos que uses marcadores de posición en lugar de cadenas
$_n_. en tus mensajes. Piensa en los marcadores de posición como buenos nombres de variables. Una semana después de escribir tu código, es probable que olvides a qué se refiere$1, pero sabrás a qué se refieren tus marcadores de posición. Para obtener más información sobre marcadores de posición y strings de sustitución, consulta la sección de marcadores de posición.descripción
Opcional. Es una descripción del mensaje que tiene como objetivo proporcionar contexto o detalles para ayudar al traductor a hacer la mejor traducción posible.
Estos son tres ejemplos de descripciones, tomados de la sección Ejemplo:
"description": "Ask for the user's name" ... "description": "Greet the user" ... "description": "Say goodbye to the user"marcadores de posición
Opcional. Define una o más substrings que se usarán en el mensaje. Estos son dos motivos por los que podrías usar un marcador de posición:
- Para definir el texto de una parte del mensaje que no debe traducirse. Ejemplos: código HTML, nombres de marcas comerciales y especificadores de formato.
- Para hacer referencia a una cadena de sustitución que se pasa a
getMessage(). Ejemplo:$1.
Cada marcador de posición tiene un nombre, un “contenido”. elemento y un “ejemplo” opcional elemento. El nombre de un marcador de posición no distingue mayúsculas de minúsculas y puede contener los mismos caracteres que el nombre de un mensaje.
El «contenido» valor del elemento es una cadena que puede referirse a cadenas de sustitución, que se especifican
con el parámetro exceptions del método i18n.getMessage. El valor de un elemento "content" suele ser algo como "Example.com" o "USD 1". Si te refieres a una cadena de sustitución que no
obtienes una cadena vacía. En la siguiente tabla, se muestra cómo se corresponden las strings $_n_ con las strings
especificada por el parámetro optionals.
| Parámetro substitutions | Valor de USD 1 | Valor de USD 2 | Valor de USD 3 |
|---|---|---|---|
userName | valor de userName | "" | "" |
["Cira", "Kathy"] | "Cira" | "Kathy" | "" |
El elemento “ejemplo” (opcional, pero muy recomendable) ayuda a los traductores, ya que muestra cómo se muestra el contenido al usuario final. Por ejemplo, un marcador de posición para un importe en dólares debe tener un ejemplo como
"$23.45"
En el siguiente fragmento, tomado de la sección Ejemplo, se muestra un elemento "marcadores de posición" que contiene dos marcadores de posición llamados "our_site" y "user". El sitio "our_site" el marcador de posición no tiene “ejemplo” porque su valor es obvio a partir del "contenido" .
"placeholders": {
"our_site": {
"content": "Example.com",
},
"user": {
"content": "$1",
"example": "Cira"
}
}