Định dạng thông báo bản địa hoá

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

Mặc dù phần giữ chỗ, chẳng hạn như $USER$ là cách tham chiếu ưu tiên đến chuỗi thay thế
(các chuỗi được chỉ định bằng tham số thay thế của i18n.getMessage), bạn cũng có thể tham chiếu
vào chuỗi thay thế ngay trong thông báo. Ví dụ: thông báo sau đây đề cập đến
ba chuỗi thay thế đầu tiên được truyền vào getMessage():
"message": "Params: $1, $2, $3"

Bất kể ví dụ đó, bạn nên tiếp tục sử dụng phần giữ chỗ thay vì chuỗi $_n_
trong thư của bạn. Hãy coi phần giữ chỗ là tên biến phù hợp. Một tuần sau khi bạn viết
mã, bạn có thể sẽ quên $1 đề cập đến nội dung gì, nhưng bạn sẽ biết phần giữ chỗ của bạn đề cập đến điều gì.
Để biết thêm thông tin về phần giữ chỗ và chuỗi thay thế, hãy xem phần phần giữ chỗ.

description

Không bắt buộc. Nội dung mô tả thư nhằm cung cấp ngữ cảnh hoặc thông tin chi tiết để giúp người dịch
giúp bạn có được bản dịch tốt nhất có thể.

Sau đây là 3 ví dụ về nội dung mô tả lấy từ phần Ví dụ:
"description": "Ask for the user's name"
...
"description": "Greet the user"
...
"description": "Say goodbye to the user"

phần giữ chỗ

Không bắt buộc. Xác định một hoặc nhiều chuỗi con cần dùng trong thông báo. Sau đây là hai lý do khiến bạn
có thể muốn sử dụng phần giữ chỗ:


Để xác định văn bản cho một phần của thông báo không được dịch. Ví dụ: Mã HTML,
tên đã đăng ký nhãn hiệu, thông số định dạng.
Để tham chiếu đến một chuỗi thay thế được truyền vào getMessage(). Ví dụ: $1.


Mỗi phần giữ chỗ đều có một tên, một "nội dung" mục và "ví dụ" tuỳ chọn mục. Tên của phần giữ chỗ
không phân biệt chữ hoa chữ thường và có thể chứa các ký tự tương tự như tên thông báo.

Phần "content" (Nội dung) giá trị của mục là một chuỗi có thể tham chiếu đến các chuỗi thay thế, được chỉ định
bằng cách sử dụng tham số thay thế của phương thức i18n.getMessage. Giá trị của một "nội dung" mục là
thường là ví dụ như "Example.com" hoặc "$1". Nếu bạn tham chiếu đến một chuỗi thay thế không
, bạn sẽ nhận được một chuỗi trống. Bảng sau đây trình bày cách các chuỗi $_n_ tương ứng với các chuỗi
được chỉ định bởi thông số thay thế.

tham số thay thế
Giá trị $1
Giá trị 2 USD
Giá trị 3 đô la
userName
giá trị của userName
""
""
["Cira", "Kathy"]
"Cira"
"Kathy"
""

"Ví dụ" mục (không bắt buộc nhưng rất nên dùng) giúp ích cho người dịch bằng cách trình bày cách nội dung
xuất hiện cho người dùng cuối. Ví dụ: phần giữ chỗ cho số tiền nên có ví dụ như
"$23.45".

Đoạn mã sau (được lấy từ phần Ví dụ) cho thấy một "phần giữ chỗ" mặt hàng
chứa hai phần giữ chỗ có tên là "our_site" và "người dùng". Trang web của chúng tôi phần giữ chỗ không có "ví dụ"
mục bởi vì giá trị của nó rõ ràng trong "nội dung" .
"placeholders": {
  "our_site": {
    "content": "Example.com",
  },
  "user": {
    "content": "$1",
    "example": "Cira"
  }
}