Formati dei messaggi di localizzazione

Ogni estensione o app internazionalizzata ha almeno un file denominato messages.json che fornisce stringhe specifiche per le impostazioni internazionali. Questa pagina descrive il formato dei file messages.json. Per informazioni su come internazionalizzare e localizzare, consulta la pagina Internazionalizzazione.

Riepilogo campi

Il seguente codice mostra i campi supportati per messages.json. Sono obbligatori solo i campi "name" e "message" .

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

Esempio

Ecco un file messages.json che definisce tre messaggi denominati "prompt_for_name", "hello" e "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"
      }
    }
  }
}

Dettagli campo

Questa sezione descrive ogni campo che può essere visualizzato in un file messages.json. Per informazioni su come viene utilizzato il file dei messaggi, ad esempio cosa succede quando le impostazioni internazionali non definiscono tutti i messaggi, consulta Internazionalizzazione.

nome

In realtà, non esiste un campo denominato "name". Il nome di questo campo è il nome del messaggio, lo stesso nome che vedi in __MSG__name___ o getMessage("_name_").

Il nome è una chiave senza distinzione tra maiuscole e minuscole che ti consente di recuperare il testo del messaggio localizzato. Il nome può includere i seguenti caratteri:

  • A-Z
  • a-z
  • 0-9
  • _ (trattino basso)
  • @
Nota: non definire nomi che iniziano con "@@". Questi nomi sono riservati ai messaggi predefiniti.

Ecco tre esempi di nomi, tratti dalla sezione Esempio:

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

Per altri esempi di utilizzo dei nomi, consulta la pagina Internazionalizzazione.

messaggio

Il messaggio tradotto, sotto forma di stringa che può contenere segnaposto. Utilizza $_placeholder_name_$ (senza distinzione tra maiuscole e minuscole) per fare riferimento a un segnaposto specifico. Ad esempio, puoi fare riferimento a un segnaposto denominato "our_site" come $our_site$, $OUR_SITE$ o $oUR_sITe$.

Ecco tre esempi di messaggi, tratti dalla sezione Esempio:

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

Per inserire un simbolo del dollaro ($) nella stringa, utilizza $$. For example, use the following code to specify the message Amount (in $):

"message": "Amount (in $$)"

Although placeholders such as $USER$ are the preferred way of referring to substitution strings (strings specified using the substitutions parameter of i18n.getMessage) you can also refer to substitution strings directly within the message. For example, the following message refers to the first three substitution strings passed into getMessage():

"message": "Params: $1, $2, $3"

Despite that example, we recommend that you stick to using placeholders instead of $_n_ strings within your messages. Think of placeholders as good variable names. A week after you write your code, you'll probably forget what $1 refers to, but you'll know what your placeholders refer to. For more information on placeholders and substitution strings, see the placeholders section.

description

Optional. A description of the message, intended to give context or details to help the translator make the best possible translation.

Here are three examples of descriptions, taken from the Example section:

"description": "Ask for the user's name"
...
"description": "Greet the user"
...
"description": "Say goodbye to the user"

placeholders

Optional. Defines one or more substrings to be used within the message. Here are two reasons you might want to use a placeholder:

  • To define the text for a part of your message that shouldn't be translated. Examples: HTML code, trademarked names, formatting specifiers.
  • To refer to a substitution string passed into getMessage(). Example: $1.

Each placeholder has a name, a "content" item, and an optional "example" item. A placeholder's name is case-insensitive and can contain the same characters as a message name.

The "content" item's value is a string that can refer to substitution strings, which are specified using the i18n.getMessage method's substitutions parameter. The value of a "content" item is typically something like "Example.com" or "$1". If you refer to a substitution string that doesn't exist, you get an empty string. The following table shows how $_n_ strings correspond to strings specified by the substitutions parameter.

substitutions parameterValue of $1Value of $2Value of $3
userNamevalue of userName""""
["Cira", "Kathy"]"Cira""Kathy"""

The "example" item (optional, but highly recommended) helps translators by showing how the content appears to the end user. For example, a placeholder for a dollar amount should have an example like "$23.45".

The following snippet, taken from the Example section, shows a "placeholders" item that contains two placeholders named "our_site" and "user". The "our_site" placeholder has no "example" item because its value is obvious from the "content" field.

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