Formatos de mensajes de localización

{
  "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."
      },
      ...
    }
  },
  ...
}

{
  "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"
      }
    }
  }
}

"prompt_for_name": {
  ...
},
"hello": {
  ...
},
"bye": {
  ...
}

"message": "What's your name?"
...
"message": "Hello, $USER$"
...
"message": "Goodbye, $USER$. Come back to $OUR_SITE$ soon!"

"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 hace referencia a
las primeras tres cadenas de sustitución que se pasan a getMessage():

messages.json:
"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. Una descripción del mensaje, con la intención de proporcionar contexto o detalles para ayudar al traductor
la mejor traducción posible.

Estos son tres ejemplos de descripciones, tomados de la sección Ejemplo:

messages.json:
"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. Estas son dos razones por las que
puedes 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 string de sustitución pasada 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 valor del elemento "content" es una cadena que puede hacer referencia a cadenas de sustitución, que se especifican con el parámetro substitutions del método i18n.getMessage. El valor de un "contenido" el elemento es
normalmente, 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 las cadenas $_n_ corresponden a las cadenas especificadas por el parámetro substitutions.

Parámetro Replaces
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" .

messages.json:
"placeholders": {
  "our_site": {
    "content": "Example.com",
  },
  "user": {
    "content": "$1",
    "example": "Cira"
  }
}