/
apdx-i18n.lyx
1376 lines (985 loc) · 24.1 KB
/
apdx-i18n.lyx
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
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#LyX 1.6.7 created this file. For more info see http://www.lyx.org/
\lyxformat 345
\begin_document
\begin_header
\textclass book
\use_default_options false
\language english
\inputencoding auto
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
\paperfontsize default
\spacing single
\use_hyperref false
\papersize default
\use_geometry false
\use_amsmath 1
\use_esint 1
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\author ""
\author ""
\end_header
\begin_body
\begin_layout Chapter
Internationalization
\begin_inset CommandInset label
LatexCommand label
name "cha:Internationalization"
\end_inset
\begin_inset Index
status open
\begin_layout Plain Layout
Internationalization | see I18N
\end_layout
\end_inset
\begin_inset Index
status open
\begin_layout Plain Layout
I18N
\end_layout
\end_inset
\end_layout
\begin_layout Standard
The ability to display pages to users of multiple languages is a common
feature of many web frameworks.
Lift builds on the underlying Java I18N foundations
\begin_inset Foot
status open
\begin_layout Plain Layout
Primarily java.util.Locale and java.util.ResourceBundle
\end_layout
\end_inset
to provide a simple yet flexible means for using Locales and translated
strings in your app.
Locales are used to control not only what language the text is in that's
presented to the user, but also number and date formatting, among others.
If you want more details on the underlying foundation of Java I18N we suggest
you visit the Internationalization Homepage at
\begin_inset Flex URL
status open
\begin_layout Plain Layout
http://java.sun.com/javase/technologies/core/basic/intl/
\end_layout
\end_inset
.
\end_layout
\begin_layout Standard
Another note is that languages are selected in Lift using language tags,
as defined in
\begin_inset Flex URL
status open
\begin_layout Plain Layout
http://www.w3.org/International/articles/language-tags/
\end_layout
\end_inset
.
Language tags are base on the ISO 639 standard
\begin_inset Foot
status open
\begin_layout Plain Layout
\begin_inset Flex URL
status open
\begin_layout Plain Layout
http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
\end_layout
\end_inset
\end_layout
\end_inset
.
In general, you should keep language tags as short as possible and avoid
adding information (such as regional specifiers) that does not provide
otherwise distinguishing information.
For example, if your Spanish page will be used for both Mexican and Spanish
clients without modification, simply use
\family typewriter
es
\family default
and not
\family typewriter
es_MX
\family default
or
\family typewriter
es_ES
\family default
.
\end_layout
\begin_layout Section
Localized Templates
\begin_inset CommandInset label
LatexCommand label
name "sec:Localized-Templates"
\end_inset
\begin_inset Index
status open
\begin_layout Plain Layout
I18N ! Localized templates
\end_layout
\end_inset
\end_layout
\begin_layout Standard
As we described in Section
\begin_inset CommandInset ref
LatexCommand vref
reference "sec:Templates"
\end_inset
, Lift automatically chooses the template for a request based on the current
locale by appending the locale's variants.
That means that a request for
\family typewriter
/index
\family default
with a calculated locale of
\family typewriter
en_US
\family default
will try these filenames, in order:
\end_layout
\begin_layout Itemize
\family typewriter
index_en_US.html
\end_layout
\begin_layout Itemize
\family typewriter
index_en.html
\end_layout
\begin_layout Itemize
\family typewriter
index.html
\end_layout
\begin_layout Standard
Note that Java upper-cases the country portion of the locale, so you need
to make sure you name your templates accordingly.
For instance, in the above example a file named
\family typewriter
index_en_us.html
\family default
wouldn't match
\begin_inset Note Note
status open
\begin_layout Plain Layout
I tested this locally.
Not sure if this is something we would want to fix in Lift
\end_layout
\end_inset
.
\end_layout
\begin_layout Section
Resource Bundles
\begin_inset CommandInset label
LatexCommand label
name "sec:Resource-Bundles"
\end_inset
\end_layout
\begin_layout Standard
Resource bundles are sets of property files
\begin_inset Foot
status open
\begin_layout Plain Layout
Technically, they can have other formats, but Lift generally only deals
with
\family typewriter
PropertyResourceBundles
\end_layout
\end_inset
that contain keyed strings for your application to use in messages.
In addition to the key/value pair contents of the files, the filename itself
is significant.
When a
\family typewriter
ResourceBundle
\family default
is specified by name, the base name is used as the default, and additional
files with names of the form
\begin_inset Quotes eld
\end_inset
<base name>_<language tag>
\begin_inset Quotes erd
\end_inset
can be used to specify translations of the default strings in a given language.
As an example, consider listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Default-door-bundle"
\end_inset
, which specifies a default resource bundle for an application that reports
the status of a door (open or closed).
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Default Door Bundle
\begin_inset CommandInset label
LatexCommand label
name "lst:Default-door-bundle"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
openStatus=The door is open
\end_layout
\begin_layout Plain Layout
closedStatus=The door is closed
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Suppose this file is called
\begin_inset Quotes eld
\end_inset
DoorMessages.properties
\begin_inset Quotes erd
\end_inset
; we can provide an additional translation for Spanish by creating a file
called
\begin_inset Quotes eld
\end_inset
DoorMessages_es.properties
\begin_inset Quotes erd
\end_inset
, shown in listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Spanish-door-bundle"
\end_inset
.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Spanish Door Bundle
\begin_inset CommandInset label
LatexCommand label
name "lst:Spanish-door-bundle"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
openStatus=La puerta está abierta
\end_layout
\begin_layout Plain Layout
closedStatus=La puerta está cerrada
\end_layout
\end_inset
\end_layout
\begin_layout Standard
When you want to retrieve a message (covered in the next two sections) Lift
will check the current Locale and see if there's a specialized ResourceBundle
available for it.
If so, it uses the messages in that file; otherwise, it uses the default
bundle.
\end_layout
\begin_layout Standard
Lift supports using multiple resource bundle files so that you can break
your messages up into functional groups.
You specify this by setting the
\family typewriter
LiftRules.resourceNames
\family default
property to a list of the base names (without a language or
\begin_inset Quotes eld
\end_inset
.properties
\begin_inset Quotes erd
\end_inset
extension):
\end_layout
\begin_layout LyX-Code
LiftRules.resourceNames = "DoorMessages" ::
\end_layout
\begin_layout LyX-Code
"DoorknobMessages" :: Nil
\end_layout
\begin_layout Standard
The order that you define the resource bundle names is the order that they'll
be searched for keys.
The message properties files should be located in your
\family typewriter
WEB-INF/classes
\family default
folder so that they are accessible from Lift's classloader
\begin_inset Foot
status open
\begin_layout Plain Layout
The properties files are retrieved with
\family typewriter
ClassLoader.getResourceAsStream
\end_layout
\end_inset
; if you're using Maven this will happen if you put your files in the
\family typewriter
src/main/resources
\family default
directory.
\end_layout
\begin_layout Standard
\align center
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "75col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout Plain Layout
Note: According to the
\family typewriter
Properties
\family default
documentation
\begin_inset Foot
status open
\begin_layout Plain Layout
\begin_inset Flex URL
status open
\begin_layout Plain Layout
http://download.oracle.com/javase/6/docs/api/java/util/Properties.html
\end_layout
\end_inset
\end_layout
\end_inset
, keys
\emph on
must
\emph default
escape significant whitespace, colons or equals signs in the key itself
with backslashes.
For example, to specify
\begin_inset Quotes eld
\end_inset
this = that
\begin_inset Quotes erd
\end_inset
as a key, you would have to write it as
\begin_inset Quotes eld
\end_inset
this
\backslash
\backslash
=
\backslash
that
\begin_inset Quotes erd
\end_inset
in the properties file.
\begin_inset Index
status open
\begin_layout Plain Layout
I18N ! whitespace in keys
\end_layout
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Section
An Important Note on Resource Bundle Resolution
\begin_inset Index
status open
\begin_layout Plain Layout
I18N ! Resource bundle resolution
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Per Java’s documentation on
\begin_inset CommandInset href
LatexCommand href
name "ResourceBundle"
target "http://java.sun.com/javase/6/docs/api/java/util/ResourceBundle.html#getBundle(java.lang.String,%20java.util.Locale,%20java.lang.ClassLoader)"
\end_inset
, resolution of property files is done in this order:
\end_layout
\begin_layout Itemize
baseName + “_” + language1 + “_” + country1 + “_” + variant1
\end_layout
\begin_layout Itemize
baseName + “_” + language1 + “_” + country1
\end_layout
\begin_layout Itemize
baseName + “_” + language1
\end_layout
\begin_layout Itemize
baseName + “_” + language2 + “_” + country2 + “_” + variant2
\end_layout
\begin_layout Itemize
baseName + “_” + language2 + “_” + country2
\end_layout
\begin_layout Itemize
baseName + “_” + language2
\end_layout
\begin_layout Itemize
baseName
\end_layout
\begin_layout Standard
where “language1”, “country1”, and “variant1” are the requested locale parameter
s, and “language2”, “country2”, “variant2” are the default locale parameters.
\end_layout
\begin_layout Standard
For example, if the default locale for your computer is “en_GB”, someone
requests a page for “ja”, and you have the following property files defined:
\end_layout
\begin_layout Itemize
Messages_fr_FR.properties
\end_layout
\begin_layout Itemize
Messages_en_GB.properties
\end_layout
\begin_layout Itemize
Messages.properties
\end_layout
\begin_layout Standard
then the
\series bold
Messages_en_GB.properties
\series default
file, and not
\series bold
Messages.properties
\series default
will be used.
If you want to change this behavior so that any undefined locales utilize
the base properties file, set your default Locale to the ROOT locale in
your
\family typewriter
Boot.scala
\family default
with the code shown in Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Setting-the-ROOT-locale"
\end_inset
:
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
\begin_inset CommandInset label
LatexCommand label
name "lst:Setting-the-ROOT-locale"
\end_inset
Setting the ROOT Default Locale
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
import java.util.Locale
\end_layout
\begin_layout Plain Layout
Locale.setDefault(Locale.ROOT)
\end_layout
\end_inset
\end_layout
\begin_layout Section
Localized Strings in Scala Code
\begin_inset CommandInset label
LatexCommand label
name "sec:Localized-Strings-in-Scala"
\end_inset
\end_layout
\begin_layout Standard
Retrieving localized strings in your Scala code is primarily performed using
the
\family typewriter
S.?
\family default
method.
When invoked with one argument the resource bundles are searched for a
key matching the given argument.
If a matching value is found it's returned.
If it can't be found then Lift calls
\family typewriter
LiftRules.localizationLookupFailureNotice
\family default
on the (key, current Locale) pair and then simply returns the key.
If you call
\family typewriter
S.?
\family default
with more than one argument, the first argument is still the key to look
up, but any remaining arguments are used as format parameters for
\family typewriter
String.format
\family default
executed on the retrieved value.
For example, listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Formatted-bundles"
\end_inset
shows a sample bundle file and the associated Scala code for using message
formatting.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Formatted Bundles
\begin_inset CommandInset label
LatexCommand label
name "lst:Formatted-bundles"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
// bundle
\end_layout
\begin_layout Plain Layout
tempMsg=The current temperature is %0.1 degrees
\end_layout
\begin_layout Plain Layout
// code
\end_layout
\begin_layout Plain Layout
var currentTmp : Double = getTemp()
\end_layout
\begin_layout Plain Layout
Text(S.?("tempMsg", currentTemp))
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Lift also provides the
\family typewriter
S.??
\family default
method, which is similar to
\family typewriter
S.?
\family default
but uses the
\family typewriter
ResourceBundle
\family default
for internal Lift strings.
Lift's resource-bundles are located in the i18n folder with the name lift-core.p
roperties The resource-bundle name is given by
\family typewriter
LiftRules.liftCoreResourceName
\family default
variable.
Generally you won't use this method.
\end_layout
\begin_layout Section
Formatting Localized Strings
\end_layout
\begin_layout Standard
While Lift provides facilities for retrieving strings from localized property
bundles (Section
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Localized-Strings-in-Scala"
\end_inset
), it does not provide direct support for localized formatting of those
strings.
There is an
\family typewriter
S.?
\family default
method which takes additional parameters, but it uses
\family typewriter
String.format
\family default
(and printf syntax) to format the strings and does not properly support
date/time formatting.
Instead, we recommend you use
\family typewriter
java.text.MessageFormat
\family default
for localized strings that will use parameters.
Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:A-Utility-Method-l10n"
\end_inset
shows a utility method that you can use in your code to localize strings
with parameters.
Note that if you have a lot of Lift's implicit conversions in scope you
may need to explicitly type some arguments as we have in this example.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
A Utility Method for Localizing Strings
\begin_inset CommandInset label
LatexCommand label
name "lst:A-Utility-Method-l10n"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
private def i10n(key : String, args : Object*) = {
\end_layout
\begin_layout Plain Layout
import java.text.{FieldPosition,MessageFormat}
\end_layout
\begin_layout Plain Layout
val formatter = new MessageFormat(S.?(key), S.locale)
\end_layout
\begin_layout Plain Layout
formatter.format(args.toArray, new StringBuffer, new FieldPosition(0)).toString
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
// Usage:
\end_layout
\begin_layout Plain Layout
<span>{i10n("welcome", new java.util.Date, 6 : Integer)}</span>
\end_layout
\end_inset
\end_layout
\begin_layout Section
Localized Strings in Templates
\begin_inset Index
status open
\begin_layout Plain Layout
I18N ! Localized templates
\end_layout
\end_inset
\end_layout
\begin_layout Standard
You can add localized strings directly in your templates through the
\family typewriter
<lift:loc />
\family default
tag.
You can either provide a locid attribute on the tag which is used as the
lookup key, or if you don't provide one, the contents of the tag will be
used as the key.
In either case, if the key can't be found in any resource bundles, the
contents of the tag will be used.
Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Using-the-loc-tag"
\end_inset
shows some examples of how you could use lift:loc.
In both examples, assume that we're using the resource bundle shown in
listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Spanish-door-bundle"
\end_inset
.
The fallthrough behavior lets us put a default text (English) directly
in the template, although for consistency you should usually provide an
explicit bundle for all languages.
\end_layout
\begin_layout Standard
\begin_inset listings
lstparams "language=XML"
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Using the loc tag
\begin_inset CommandInset label
LatexCommand label
name "lst:Using-the-loc-tag"
\end_inset
\end_layout
\end_inset
\end_layout