Jede internationalisierte Erweiterung oder App enthält mindestens eine Datei mit dem Namen messages.json, die länderspezifische Strings enthält. Auf dieser Seite wird das Format von messages.json-Dateien beschrieben. Informationen zur
Internationalisierung und Lokalisierung finden Sie auf der Seite Internationalisierung.
Felder – Übersicht
Der folgende Code zeigt die unterstützten Felder für messages.json. Nur die Felder „name“ und „message“
sind erforderlich.
{
"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."
},
...
}
},
...
}
Beispiel
Hier ist eine messages.json-Datei, in der drei Nachrichten mit den Namen „prompt_for_name“, „hello“ und „bye“ definiert sind:
{
"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"
}
}
}
}
Felddetails
In diesem Abschnitt werden die einzelnen Felder beschrieben, die in einer messages.json-Datei vorkommen können. Weitere Informationen zur Verwendung der
Nachrichtendatei, z. B. was passiert, wenn in einem Gebietsschema nicht alle Nachrichten definiert sind, finden Sie unter
Internationalisierung.
name
Es gibt kein Feld mit dem Namen „name“. Der Name dieses Felds ist der Name der Nachricht, also derselbe
Name , der in __MSG__name___ oder getMessage("_name_") angezeigt wird.
Der Name ist ein Schlüssel, bei dem die Groß-/Kleinschreibung nicht berücksichtigt wird. Mit ihm können Sie den lokalisierten Nachrichtentext abrufen. Der Name kann die folgenden Zeichen enthalten:
- A–Z
- a–z
- 0–9
- _ (Unterstrich)
- @
Hier sind drei Beispiele für Namen aus dem Beispiel Abschnitt:
"prompt_for_name": {
...
},
"hello": {
...
},
"bye": {
...
}
Weitere Beispiele für die Verwendung von Namen finden Sie auf der Seite Internationalisierung.
Nachricht
Die übersetzte Nachricht in Form eines Strings, der Platzhalter enthalten kann. Verwenden Sie $_placeholder_name_$ (Groß-/Kleinschreibung wird nicht berücksichtigt), um auf einen bestimmten Platzhalter zu verweisen. Sie können beispielsweise auf einen Platzhalter mit dem Namen „our_site“ als $our_site$, $OUR_SITE$ oder $oUR_sITe$ verweisen.
Hier sind drei Beispiele für Nachrichten aus dem Beispiel Abschnitt:
"message": "What's your name?"
...
"message": "Hello, $USER$"
...
"message": "Goodbye, $USER$. Come back to $OUR_SITE$ soon!"
Wenn Sie ein Dollarzeichen ($) in den String einfügen möchten, verwenden Sie $$. 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 intogetMessage():"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$1refers 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 parameter Value of $1 Value of $2 Value 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" } }