Ulusallaştırılmış her uzantı veya uygulamada, yerel ayara özgü dizeler sağlayan messages.json adlı en az bir dosya bulunur. Bu sayfada, messages.json dosyalarının biçimi açıklanmaktadır. Uluslararası hale getirme ve yerelleştirme hakkında bilgi edinmek için Uluslararası hale getirme sayfasına bakın.
Alan özeti
Aşağıdaki kodda messages.json için desteklenen alanlar gösterilmektedir. Yalnızca "ad" ve "mesaj" alanları zorunludur.
{
"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."
},
...
}
},
...
}
Örnek
Aşağıda, "prompt_for_name", "hello" ve "bye" adlı üç mesajı tanımlayan bir messages.json dosyası verilmiştir:
{
"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"
}
}
}
}
Alan ayrıntıları
Bu bölümde, messages.json dosyasında görünebilecek her alan açıklanmaktadır. İleti dosyasının nasıl kullanıldığıyla ilgili ayrıntılar (ör. bir yerel ayar tüm iletileri tanımlamadığında ne olur?) için Uluslararasılaştırma başlıklı makaleyi inceleyin.
ad
Aslında "ad" adlı bir alan yok. Bu alanın adı, iletinin adıdır. Bu ad, __MSG__name___ veya getMessage("_name_")'da gördüğünüz adla aynıdır.
Ad, yerelleştirilmiş ileti metnini almanızı sağlayan büyük/küçük harfe duyarlı olmayan bir anahtardır. Ad aşağıdaki karakterleri içerebilir:
- A'dan Z'ye
- a-z
- 0-9
- _ (alt çizgi)
- @
Örnek bölümünden alınan üç ad örneğini aşağıda bulabilirsiniz:
"prompt_for_name": {
...
},
"hello": {
...
},
"bye": {
...
}
Ad kullanmayla ilgili daha fazla örnek için Uluslararasılaştırma sayfasına bakın.
mesaj
Çevrilen ileti, yer tutucular içerebilen bir dize biçiminde. Belirli bir yer tutucuyu belirtmek için $_placeholder_name_$ (büyük/küçük harf duyarlı değildir) kullanın. Örneğin, "our_site" adlı bir yer tutucuyu $our_site$, $OUR_SITE$ veya $oUR_sITe$ olarak belirtebilirsiniz.
Örnek bölümünden alınan üç mesaj örneğini aşağıda bulabilirsiniz:
"message": "What's your name?"
...
"message": "Hello, $USER$"
...
"message": "Goodbye, $USER$. Come back to $OUR_SITE$ soon!"
Dizeye dolar işareti ($) eklemek için $$. For example, use the following code to specify
the message Amount (in $):
"message": "Amount (in $$)" kullanın.
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" } }