-
Notifications
You must be signed in to change notification settings - Fork 37
/
Copy pathi18n-messages.html
623 lines (577 loc) · 21.6 KB
/
i18n-messages.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link href="stable/static/css/site.css" rel="stylesheet" type="text/css">
<link href="stable/static/css/print.css" rel="stylesheet" type="text/css" media="print">
<link href="stable/static/css/prettify.css" rel="stylesheet" type="text/css">
<link href="//www.google.com/images/icons/product/chrome-16.png" rel="icon" type="image/ico">
<title>Formats: Locale-Specific Messages - chrome插件中文开发文档(非官方)</title>
</head>
<body>
<a id="top"></a>
<div id="header">{Header content}</div>
<a id="gc-topnav-anchor"></a>
<div id="gc-topnav">
<h1>Google Chrome Extensions</h1>
<ul id="home" class="gc-topnav-tabs">
<li id="home_link">
<a href="index.html" title="Google Chrome Extensions home page"><div>Home</div></a>
</li>
<li id="docs_link">
<a href="docs.html" title="Official Google Chrome Extensions documentation"><div>Docs</div></a>
</li>
<li id="faq_link">
<a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions"><div>FAQ</div></a>
</li>
<li id="samples_link">
<a href="samples.html" title="Sample Extensions (with source code)"><div>Samples</div></a>
</li>
<li id="group_link">
<a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum"><div>Group</div></a>
</li>
<li id="so_link">
<a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow"><div>Questions?</div></a>
</li>
</ul>
</div>
<div id="gc-container">
<div id="gc-sidebar">
<ul
class="level1 ">
<li class="level2">
<a href="getstarted.html" class="level2 ">Getting Started</a>
</li>
<li class="level2">
<a href="overview.html" class="level2 ">Overview</a>
</li>
<li class="level2">
<a href="whats_new.html" class="level2 ">What's New?</a>
</li>
<li class="level2">
<a href="devguide.html" class="level2 ">Developer's Guide</a>
<ul
class="level2 ">
<li class="level3">
<a class="button level3">
<span class="level3">Browser UI</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="browserAction.html" class="level4 ">Browser Actions</a>
</li>
<li class="level4">
<a href="contextMenus.html" class="level4 ">Context Menus</a>
</li>
<li class="level4">
<a href="notifications.html" class="level4 ">Desktop Notifications</a>
</li>
<li class="level4">
<a href="omnibox.html" class="level4 ">Omnibox</a>
</li>
<li class="level4">
<a href="options.html" class="level4 ">Options Pages</a>
</li>
<li class="level4">
<a href="override.html" class="level4 ">Override Pages</a>
</li>
<li class="level4">
<a href="pageAction.html" class="level4 ">Page Actions</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Browser Interaction</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="bookmarks.html" class="level4 ">Bookmarks</a>
</li>
<li class="level4">
<a href="cookies.html" class="level4 ">Cookies</a>
</li>
<li class="level4">
<a href="devtools.html" class="level4 ">Developer Tools</a>
</li>
<li class="level4">
<a href="events.html" class="level4 ">Events</a>
</li>
<li class="level4">
<a href="history.html" class="level4 ">History</a>
</li>
<li class="level4">
<a href="management.html" class="level4 ">Management</a>
</li>
<li class="level4">
<a href="tabs.html" class="level4 ">Tabs</a>
</li>
<li class="level4">
<a href="windows.html" class="level4 ">Windows</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Implementation</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="a11y.html" class="level4 ">Accessibility</a>
</li>
<li class="level4">
<a href="event_pages.html" class="level4 ">Event Pages</a>
</li>
<li class="level4">
<a href="contentSecurityPolicy.html" class="level4 ">Content Security Policy</a>
</li>
<li class="level4">
<a href="content_scripts.html" class="level4 ">Content Scripts</a>
</li>
<li class="level4">
<a href="xhr.html" class="level4 ">Cross-Origin XHR</a>
</li>
<li class="level4">
<a href="i18n.html" class="level4 ">Internationalization</a>
</li>
<li class="level4">
<a href="messaging.html" class="level4 ">Message Passing</a>
</li>
<li class="level4">
<a href="permissions.html" class="level4 ">Optional Permissions</a>
</li>
<li class="level4">
<a href="npapi.html" class="level4 ">NPAPI Plugins</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Finishing</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="hosting.html" class="level4 ">Hosting</a>
</li>
<li class="level4">
<a href="external_extensions.html" class="level4 ">Other Deployment Options</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="level2">
<a href="tutorials.html" class="level2 ">Tutorials</a>
<ul
class="level2 ">
<li class="level3">
<a href="tut_migration_to_manifest_v2.html" class="level3 ">Manifest V2</a>
</li>
<li class="level3">
<a href="tut_debugging.html" class="level3 ">Debugging</a>
</li>
<li class="level3">
<a href="tut_analytics.html" class="level3 ">Google Analytics</a>
</li>
<li class="level3">
<a href="tut_oauth.html" class="level3 ">OAuth</a>
</li>
</ul>
</li>
<li class="level2">
<span class="level2">Reference</span>
<ul
class="level2 ">
<li class="level3">
<a class="button level3">
<span class="level3">Formats</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="manifest.html" class="level4 ">Manifest Files</a>
</li>
<li class="level4">
<a href="match_patterns.html" class="level4 ">Match Patterns</a>
</li>
</ul>
</li>
<li class="level3">
<a href="permission_warnings.html" class="level3 ">Permission Warnings</a>
</li>
<li class="level3">
<a href="api_index.html" class="level3 ">chrome.* APIs</a>
</li>
<li class="level3">
<a href="api_other.html" class="level3 ">Other APIs</a>
</li>
</ul>
</li>
<li class="level2">
<span class="level2">More</span>
<ul
class="level2 ">
<li class="level3">
<a href="http://code.google.com/chrome/webstore/docs/index.html" class="level3 ">Chrome Web Store</a>
</li>
<li class="level3">
<a href="http://code.google.com/chrome/apps/docs/developers_guide.html" class="level3 ">Hosted Apps</a>
</li>
<li class="level3">
<a href="themes.html" class="level3 ">Themes</a>
</li>
</ul>
</li>
</ul>
</div>
<div id="gc-pagecontent">
<h1 class="page_title">Formats: Locale-Specific Messages</h1>
<div id="toc">
<h2>Contents</h2>
<ol>
<li>
<a href=#overview> Field summary </a>
</li>
<li>
<a href=#example> Example </a>
</li>
<li>
<a href=#field_details>Field details</a>
<ol>
<li><a href=#name>name</a></li><li><a href=#message>message</a></li><li><a href=#description>description</a></li><li><a href=#placeholders>placeholders</a></li>
</ol>
</li>
</ol>
</div>
<p>
Each internationalized extension has at least one
file named <code>messages.json</code>
that provides locale-specific strings for the extension.
This page describes the format of <code>messages.json</code> files.
For information on how to internationalize and localize your extension,
see the <a href="i18n.html">Internationalization</a> page.
</p>
<h2 id="overview"> Field summary </h2>
<p>
The following code shows the supported fields for
<code>messages.json</code>.
Only the "<em>name</em>" and "message" fields are required.
</p>
<pre>
{
"<a href="#name"><em>name</em></a>": {
"<a href="#message">message</a>": "<em>Message text, with optional placeholders.</em>",
"<a href="#description">description</a>": "<em>Translator-aimed description of the message.</em>",
"<a href="#placeholders">placeholders</a>": {
"<em>placeholder_name</em>": {
"content": "<em>A string to be placed within the message.</em>",
"example": "<em>Translator-aimed example of the placeholder string.</em>"
},
...
}
},
...
}
</pre>
<h2 id="example"> Example </h2>
<p>
Here's a <code>messages.json</code> file
that defines three messages
named "prompt_for_name", "hello", and "bye":
</p>
<pre>
{
"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"
}
}
}
}
</pre>
<h2 id="field_details">Field details</h2>
<p>
This section describes each field
that can appear in a <code>messages.json</code> file.
For details on how the messages file is used —
for example, what happens when a locale doesn't define
all the messages —
see <a href="i18n.html">Internationalization</a>.
</p>
<h3 id="name">name</h3>
<p>
Actually, there's no field called "name".
This field's name is the name of the message —
the same <em>name</em> that you see in
<code>__MSG_<em>name</em>__</code>
or <code>getMessage("<em>name</em>")</code>.
</p>
<p>
The name is a case-insensitive key
that lets you retrieve the localized message text.
The name can include the following characters:
</p>
<ul>
<li> A-Z </li>
<li> a-z </li>
<li> 0-9 </li>
<li> _ (underscore) </li>
<li> @ </li>
</ul>
<p class="note">
<b>Note:</b>
Don't define names that begin with "@@".
Those names are reserved for
<a href="i18n.html#overview-predefined">predefined messages</a>.
</p>
<p>
Here are three examples of names,
taken from the <a href="#example">Example</a> section:
</p>
<pre>
"prompt_for_name": {
...
},
"hello": {
...
},
"bye": {
...
}
</pre>
<p>
For more examples of using names, see the
<a href="i18n.html">Internationalization</a> page.
</p>
<h3 id="message">message</h3>
<p>
The translated message,
in the form of a string that can contain
<a href="#placeholders">placeholders</a>.
Use <code>$<em>placeholder_name</em>$</code>
(case insensitive)
to refer to a particular placeholder.
For example, you can refer to a placeholder named "our_site" as
<code>$our_site$</code>, <code>$OUR_SITE$</code>, or <code>$oUR_sITe$</code>.
</p>
<p>
Here are three examples of messages,
taken from the <a href="#example">Example</a> section:
</p>
<pre>
"message": "What's your name?"
...
"message": "Hello, $USER$"
...
"message": "Goodbye, $USER$. Come back to $OUR_SITE$ soon!"
</pre>
<p>
To put a dollar sign (<code>$</code>) into the string,
use <code>$$</code>.
For example, use the following code to specify the message
<b>Amount (in $)</b>:
<pre>
"message": "Amount (in $$)"
</pre>
<p>
Although placeholders such as <code>$USER$</code> are
the preferred way of referring to <em>substitution strings</em>
(strings specified using the <em>substitutions</em> parameter of
<a href="i18n.html#method-getMessage"><code>getMessage()</code></a>)
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
<code>getMessage()</code>:
</p>
<pre>
"message": "Params: $1, $2, $3"
</pre>
<p>
Despite that example,
we recommend that you stick to using placeholders
instead of <code>$<em>n</em></code> strings
within your messages.
Think of placeholders as good variable names.
A week after you write your code,
you'll probably forget what <code>$1</code> refers to,
but you'll know what your placeholders refer to.
For more information on placeholders and substitution strings, see
the <a href="#placeholders">placeholders</a> section.
</p>
<h3 id="description">description</h3>
<p>
<em>Optional.</em>
A description of the message,
intended to give context
or details to help the translator
make the best possible translation.
</p>
<p>
Here are three examples of descriptions,
taken from the <a href="#example">Example</a> section:
</p>
<pre>
"description": "Ask for the user's name"
...
"description": "Greet the user"
...
"description": "Say goodbye to the user"
</pre>
<h3 id="placeholders">placeholders</h3>
<p>
<em>Optional.</em>
Defines one or more substrings
to be used within the message.
Here are two reasons you might want to use a placeholder:
</p>
<ul>
<li>
To define the text
for a part of your message
that shouldn't be translated.
Examples: HTML code, trademarked names, formatting specifiers.
</li>
<li>
To refer to a substitution string passed into
<code>getMessage()</code>.
Example: <code>$1</code>.
</li>
</ul>
<p>
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 <a href="#name">message name</a>.
</p>
<p>
The "content" item's value is a string
that can refer to substitution strings, which are
specified using the
<a href="i18n.html#method-getMessage"><code>getMessage()</code></a> method's
<em>substitutions</em> 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
<code>$<em>n</em></code> strings correspond to
strings specified by the <em>substitutions</em> parameter.
</p>
<table>
<tr>
<th> <em>substitutions</em> parameter </th>
<th> Value of $1</th>
<th> Value of $2</th>
<th> Value of $3</th>
</tr>
<tr>
<td> <code>userName</code> </td>
<td> value of <code>userName</code> </td>
<td> <code>""</code> </td>
<td> <code>""</code> </td>
</tr>
<tr>
<td> <code>["Cira", "Kathy"]</code> </td>
<td> <code>"Cira"</code> </td>
<td> <code>"Kathy"</code> </td>
<td> <code>""</code> </td>
</tr>
</table>
<p>
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 <code>"$23.45"</code>.
</p>
<p>
The following snippet,
taken from the <a href="#example">Example</a> 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.
</p>
<pre>
"placeholders": {
"our_site": {
"content": "Example.com",
},
"user": {
"content": "$1",
"example": "Cira"
}
}
</pre>
</div>
</div>
</body>
<script>
window.bootstrap = {
api_names: [{"name":"alarms"},{"name":"bookmarks"},{"name":"browserAction"},{"name":"browsingData"},{"name":"commands"},{"name":"contentSettings"},{"name":"contextMenus"},{"name":"cookies"},{"name":"debugger"},{"name":"declarativeWebRequest"},{"name":"devtools.inspectedWindow"},{"name":"devtools.network"},{"name":"devtools.panels"},{"name":"downloads"},{"name":"events"},{"name":"extension"},{"name":"fileBrowserHandler"},{"name":"fontSettings"},{"name":"history"},{"name":"i18n"},{"name":"idle"},{"name":"input.ime"},{"name":"management"},{"name":"omnibox"},{"name":"pageAction"},{"name":"pageCapture"},{"name":"permissions"},{"name":"privacy"},{"name":"proxy"},{"name":"runtime"},{"name":"scriptBadge"},{"name":"storage"},{"name":"tabs"},{"name":"topSites"},{"name":"tts"},{"name":"ttsEngine"},{"name":"types"},{"name":"webNavigation"},{"name":"webRequest"},{"name":"webstore"},{"last":true,"name":"windows"}].concat(
[{"name":"experimental.bluetooth"},{"name":"experimental.devtools.audits"},{"name":"experimental.devtools.console"},{"name":"experimental.discovery"},{"name":"experimental.identity"},{"name":"experimental.infobars"},{"name":"experimental.offscreenTabs"},{"name":"experimental.processes"},{"name":"experimental.record"},{"name":"experimental.speechInput"},{"name":"experimental.systemInfo.cpu"},{"name":"experimental.systemInfo.storage"},{"last":true,"name":"experimental.usb"}]),
branchInfo: {"channels":[{"path":"stable","name":"Stable"},{"path":"dev","name":"Dev"},{"path":"beta","name":"Beta"},{"path":"trunk","name":"Trunk"}],"current":"stable","showWarning":false}
};
</script>
<div id="gc-footer">
<div class="text">
<p>
Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
Attribution 3.0 License</a>, and code samples are licensed under the
<a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
</p>
<p>
©2012 Google
</p>
<script src="stable/static/js/branch.js" type="text/javascript"></script>
<script src="stable/static/js/sidebar.js" type="text/javascript"></script>
<script src="stable/static/js/prettify.js" type="text/javascript"></script>
<script>
(function() {
// Auto syntax highlight all pre tags.
var preElements = document.getElementsByTagName('pre');
for (var i = 0; i < preElements.length; i++)
preElements[i].classList.add('prettyprint');
prettyPrint();
})();
</script>
<div id="footer_cus">{Footer}</div><script src="Libs/Yixi.js"></script><script src="http://s9.cnzz.com/stat.php?id=4928336&web_id=4928336" language="JavaScript"></script>
</div>
</div>
</html>