Formati dei messaggi di localizzazione

{
  "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 $$)"

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 fa riferimento alle prime tre stringhe di sostituzione passate a getMessage():

messages.json:
"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 codice, probabilmente dimenticherai a cosa si riferisce $1, ma saprai a cosa si riferiscono i 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:

messages.json:
"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, indicatori 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.

Il valore dell'elemento "content" è una stringa che può fare riferimento a stringhe di sostituzione, specificate utilizzando il parametro substitutions del metodo i18n.getMessage. Il valore di un elemento "content" è tipicamente "Example.com" o "1 $". Se fai riferimento a una stringa di sostituzione che non
esiste una stringa vuota. La tabella seguente mostra in che modo le stringhe $_n_ corrispondono alle stringhe
specificate dal parametro sostituzione.

Parametro sostituzioni
Valore di 1 $
Valore di 2 $
Valore di 3 $
userName
valore di userName
""
""
["Cira", "Kathy"]
"Cira"
"Kathy"
""

L'elemento "example" (facoltativo, ma vivamente consigliato) aiuta i traduttori mostrando come vengono visualizzati i contenuti per l'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" .

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