Format pesan pelokalan

Setiap ekstensi yang diinternasionalisasi memiliki setidaknya satu file bernama messages.json yang menyediakan string khusus lokalitas. Halaman ini menjelaskan format file messages.json. Untuk mengetahui informasi tentang cara menginternasionalisasi dan melokalkan, lihat halaman Internasionalisasi.

Ringkasan kolom

Kode berikut menunjukkan kolom yang didukung untuk messages.json. Hanya kolom "name" dan "message" yang wajib diisi.

messages.json:

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

Contoh

Berikut adalah file messages.json yang menentukan tiga pesan bernama "prompt_for_name", "hello", dan "bye":

messages.json:

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

Detail kolom

Bagian ini menjelaskan setiap kolom yang dapat muncul dalam file messages.json. Untuk mengetahui detail tentang cara file pesan digunakan—misalnya, apa yang terjadi saat lokalitas tidak menentukan semua pesan—lihat Internasionalisasi.

nama

Sebenarnya, tidak ada kolom bernama "name". Nama kolom ini adalah nama pesan—nama yang sama yang Anda lihat di __MSG__name___ atau getMessage("_name_").

Nama adalah kunci yang tidak peka huruf besar/kecil yang memungkinkan Anda mengambil teks pesan yang dilokalkan. Nama dapat mencakup karakter berikut:

  • A-Z
  • a-z
  • 0-9
  • _ (garis bawah)
  • @

Berikut adalah tiga contoh nama, yang diambil dari bagian Contoh:

messages.json:

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

Untuk contoh selengkapnya tentang penggunaan nama, lihat halaman Internasionalisasi.

pesan

Pesan yang diterjemahkan, dalam bentuk string yang dapat berisi placeholder. Gunakan $_placeholder_name_$ (tidak peka huruf besar/kecil) untuk merujuk ke placeholder tertentu. Misalnya, Anda dapat merujuk ke placeholder bernama "our_site" sebagai $our_site$, $OUR_SITE$, atau $oUR_sITe$.

Berikut tiga contoh pesan, yang diambil dari bagian Contoh:

messages.json:

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

Untuk memasukkan tanda dolar ($) ke dalam string, gunakan $$. For example, use the following code to specify the message Amount (in $):

messages.json:

"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():

messages.json:

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

messages.json:

"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.

messages.json:

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