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. In questa pagina viene descritto 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. Solo "name" e "messaggio" sono obbligatori.

{
  "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 "ciao":

{
  "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 tutti i campi che possono essere visualizzati in un file messages.json. Per i dettagli su come di messaggi (ad esempio, cosa succede quando le impostazioni internazionali non definiscono tutti i messaggi) Internazionalizzazione.

nome

Non ci sono campi chiamati "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 consente di recuperare il testo localizzato del messaggio. Il nome può include 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 sull'internazionalizzazione.

messaggio

Il messaggio tradotto, sotto forma di stringa che può contenere segnaposto. Utilizza le funzionalità di $_placeholder_name_$ (senza distinzione tra maiuscole e minuscole) per fare riferimento a un determinato segnaposto. Ad esempio, puoi fai riferimento a un segnaposto denominato "nostro_sito" 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 il simbolo del dollaro ($) nella stringa, utilizza $$. For example, use the following code to specify the message Amount (in $):

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

Sebbene i segnaposto come $USER$ siano il modo preferito per fare riferimento alle stringhe di sostituzione (stringhe specificate utilizzando il parametro substitutions di i18n.getMessage) puoi anche fare riferimento alle stringhe di sostituzione direttamente all'interno del messaggio. Ad esempio, il seguente messaggio si riferisce le prime tre stringhe di sostituzione passate a getMessage():

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

Nonostante questo esempio, ti consigliamo di utilizzare i segnaposto anziché le stringhe $_n_ all'interno dei tuoi messaggi. Pensa ai segnaposto come a buoni nomi di variabili. Una settimana dopo aver scritto il non avrai probabilmente dimenticato di cosa si intende per $1, ma puoi già sapere a cosa si riferiscono i tuoi segnaposto. Per ulteriori informazioni sui segnaposto e sulle stringhe di sostituzione, consulta la sezione relativa ai segnaposto.

descrizione

Facoltativo. Una descrizione del messaggio, con lo scopo di fornire un contesto o dettagli per aiutare il traduttore per rendere la traduzione migliore possibile.

Ecco tre esempi di descrizioni, tratti dalla sezione Esempio:

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

segnaposto

Facoltativo. Definisce una o più sottostringhe da utilizzare all'interno del messaggio. Ecco due motivi per cui potresti voler utilizzare un segnaposto:

  • Per definire il testo di una parte del messaggio che non deve essere tradotta. Esempi: codice HTML, nomi con marchio registrato, identificatori di formattazione.
  • Fare riferimento a una stringa di sostituzione passata a getMessage(). Esempio: $1.

Ogni segnaposto ha un nome, un "contenuto" e un "esempio" facoltativo molto utile. Il nome di un segnaposto non fa distinzione tra maiuscole e minuscole e può contenere gli stessi caratteri di un nome messaggio.

I "contenuti" di un elemento è una stringa che può fare riferimento a stringhe di sostituzione, utilizzando il parametro substitutions del metodo i18n.getMessage. Il valore di un "contenuto" l'elemento è in genere, ad esempio "Example.com" o "$1". Se fai riferimento a una stringa di sostituzione che non esistenti, ottenerai una stringa vuota. La tabella seguente mostra la corrispondenza delle stringhe $_n_ specificato dal parametro substitutions.

Parametro sostituzioniValore di 1 $Valore di 2 $Valore di 3 $
userNamevalore di userName""""
["Cira", "Kathy"]"Cira""Kathy"""

L'"esempio" (facoltativo, ma vivamente consigliato) aiuta i traduttori mostrando in che modo i contenuti visibile all'utente finale. Ad esempio, un segnaposto per un importo in dollari dovrebbe avere un esempio come "$23.45".

Il seguente snippet, tratto dalla sezione Esempio, mostra un "segnaposto" elemento che contiene due segnaposto denominati "nostro_sito" e "user". Il "nostro_sito" il segnaposto non contiene un "esempio" perché il suo valore risulta evidente dalla sezione "content" .

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