Skip to Content
Last modified by Pascal Robert on 2015/05/04 04:24
From version 55.1
edited by Ramsey Gurley
on 2010/02/02 23:01
Change comment: There is no comment for this version
To version 59.1
edited by Johan Henselmans
on 2015/05/04 04:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Web Applications-Development-Localization and Internationalization
1 +Development-Localization and Internationalization
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ramsey
1 +XWiki.johanhenselmans
Content
... ... @@ -1,11 +1,10 @@
1 1  == Unicode ==
2 2  
3 -See also: [[UTF-8 Encoding Tips]]
3 +See also: [[doc:UTF-8 Encoding Tips]]
4 4  
5 5  To Enable Unicode for your WO app, add the following to your application constructor:
6 6  
7 7  {{code}}
8 -
9 9  WOMessage.setDefaultEncoding("UTF8");
10 10  
11 11  {{/code}}
... ... @@ -14,8 +14,7 @@
14 14  
15 15  Then you just need to tell the browser. Make all your .wo pages include this meta tag in their HTML:
16 16  
17 -{{code value="xml"}}
18 -
16 +{{code 0="xml"}}
19 19  <html>
20 20  <head>
21 21  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
... ... @@ -28,7 +28,6 @@
28 28  Great tip - here is a simple method call you can stick in your Application object to automatically achieve the results outlined above:
29 29  
30 30  {{code}}
31 -
32 32  private boolean enableUTFEncoding = false;
33 33  
34 34  public void enableUTFEncoding() {
... ... @@ -53,7 +53,6 @@
53 53  To make sure that UTF-8 is supported in multipart forms as well, you have to add the following code to your Application object:
54 54  
55 55  {{code}}
56 -
57 57  public WORequest createRequest(String aMethod, String aURL, String anHTTPVersion,
58 58   NSDictionary someHeaders, NSData aContent, NSDictionary someInfo) {
59 59   WORequest newRequest = super.createRequest(aMethod, aURL, anHTTPVersion,
... ... @@ -64,26 +64,25 @@
64 64  
65 65  {{/code}}
66 66  
67 -To make WOFileUpload components working I also had to add the launch parameter WOUseLegacyMultipartParser true to my application. This launch parameter forces the parsing of all form values, the first time WORequest.formValues is called. See the [[apple developer documentation>>http://developer.apple.com/documentation/WebObjects/Reference/api/com/webobjects/appserver/WORequest.html]] for additional information. Without WOUseLegacyMultipartParser true I had serious problems in my applications using a WOFileUpload component because the bindings //data// and //filePath// have been emptied after a form POST.
63 +To make WOFileUpload components working I also had to add the launch parameter -WOUseLegacyMultipartParser true to my application. This launch parameter forces the parsing of all form values, the first time WORequest.formValues is called. See the [[apple developer documentation>>url:http://wocommunity.org/documents/javadoc/WebObjects/5.4.2/com/webobjects/appserver/WORequest.html||shape="rect"]] for additional information. Without -WOUseLegacyMultipartParser true I had serious problems in my applications using a WOFileUpload component because the bindings //data// and //filePath// have been emptied after a form POST.
68 68  
69 69  With Jesse's code and this extension, you will be able to handle UTF-8 character data correctly in your WO application.
70 70  
71 -If you use localized strings in your UTF-8 application you may also check out Project Wonder's [[ERXLocalizer>>WOnder-ERXLocalizer]] class.
67 +If you use localized strings in your UTF-8 application you may also check out Project Wonder's [[ERXLocalizer>>doc:WOnder-ERXLocalizer]] class.
72 72  
73 -=== Project Localization tips [[~~ramsey]] ===
69 +=== Project Localization tips ===
74 74  
75 75  The following are some tips and suggestions for localizing a project in WOLips using Project Wonder.
76 76  
77 77  ===== Eclipse Default Encoding =====
78 78  
79 -I prefer to keep my entire project in UTF-8 format for consistency. You can set that in your Eclipse General->Workspace preferences. The exception, of course will be your Localizable.strings files. Those have to be in UTF-16 format. I generally get warnings about the WOO file for my initial Main component whenever I create a new project, but if you right-click your Main.wo you'll see "Properties" at the very bottom of the contextual menu. Open that and flip your encoding between project default and UTF-8, save it, then open it back up and return it to the project default and the problem should go away. This is also how you set your Localized.strings file to UTF-16 even if the rest of your project is not UTF-16.
75 +I prefer to keep my entire project in UTF-8 format for consistency. You can set that in your Eclipse General->Workspace preferences. The exception, of course will be your Localizable.strings files. Those have to be in UTF-16 format. I generally get warnings about the WOO file for my initial Main component whenever I create a new project, but if you right-click your Main.wo you'll see "Properties" at the very bottom of the contextual menu. Open that and flip your encoding between project default and UTF-8, save it, then open it back up and return it to the project default and the problem should go away. This is also how you set your Localized.strings file to UTF-16 even if the rest of your project is not UTF-16.
80 80  
81 81  ===== Properties file =====
82 82  
83 -Let's say your project will be available in English and Japanese. You'll want to include the following in your Project->Resources->Properties file:
79 +Let's say your project will be available in English and Japanese. You'll want to include the following in your Project->Resources->Properties file:
84 84  
85 85  {{noformat}}
86 -
87 87  # Localization
88 88  er.extensions.ERXLocalizer.defaultLanguage=English
89 89  er.extensions.ERXLocalizer.fileNamesToWatch=("Localizable.strings","ValidationTemplate.strings")
... ... @@ -98,67 +98,77 @@
98 98  Note that if you need to customize the locale for a language, such as Canadian French, you can do so with this property:
99 99  
100 100  {{noformat}}
101 -
102 102  er.extensions.ERXLocalizer.French_CA.locale = fr_ca
103 103  
104 104  {{/noformat}}
105 105  
106 -The other changes are then in the er.extensions.ERXLocalizer.availableLanguages and ERXLanguages:
107 -In the above case after adding canadian french these would change in:
100 +(% style="color: rgb(51,51,51);" %)The other changes are then in the er.extensions.ERXLocalizer.availableLanguages and ERXLanguages:(%%)
101 + (% style="color: rgb(51,51,51);" %)In the above case after adding canadian french these would change in:
108 108  
109 109  {{noformat}}
110 -
111 111  er.extensions.ERXLocalizer.availableLanguages=(English,Japanese,French_CA)
112 112  
113 113  {{/noformat}}
114 114  
108 +(% style="color: rgb(51,51,51);" %)Localized formatters use this property:
109 +
110 +{{noformat}}
111 +er.extensions.ERXLocalizer.useLocalizedFormatters=false
112 +
113 +{{/noformat}}
114 +
115 115  ===== Localized strings and components =====
116 116  
117 -For each language available, you will need a corresponding Localizable.strings file. This file should be located in Projects->Resources->"Lang".lproj directory. In these directories, you'll store localized resources such as Localizable.strings files and localized components. So, continuing with the above example, you should create two new Localizable.strings files in the following places in your project directory:
117 +For each language available, you will need a corresponding Localizable.strings file. This file should be located in Projects->Resources->"Lang".lproj directory. In these directories, you'll store localized resources such as Localizable.strings files and localized components. So, continuing with the above example, you should create two new Localizable.strings files in the following places in your project directory:
118 118  
119 -Project->Resources->English.lproj->Localizable.strings
120 -Project->Resources->Japanese.lproj->Localizable.strings
121 -Project->Resources->French//CA.lproj->Localizable.strings//
119 +>Project->Resources->English.lproj->Localizable.strings
120 +> Project->Resources->Japanese.lproj->Localizable.strings
121 +> Project->Resources->French_CA.lproj->Localizable.strings
122 122  
123 -As mentioned earlier, it's recommended that these be in UTF-16 format. You can do that by right clicking on the file in WOLips and selecting "Properties." In the resources panel, change from the project default encoding to UTF-16.
123 +As mentioned earlier, it's recommended that these be in UTF-16 format. You can do that by right clicking on the file in WOLips and selecting "Properties." In the resources panel, change from the project default encoding to UTF-16.
124 124  
125 -If you have any components that need localizing, then you should relocate that component from your Project->Components folder into the appropriate Lang.lproj folder. Then make a copy of the component into the remaining lproj directories and you can begin the process of localizing the component. You do not need more than one copy of the associated API or java file. You only need duplicates of the WO. So, as an example, if you wanted to localize
125 +If you have any components that need localizing, then you should relocate that component from your Project->Components folder into the appropriate Lang.lproj folder. Then make a copy of the component into the remaining lproj directories and you can begin the process of localizing the component. You do not need more than one copy of the associated API or java file. You only need duplicates of the WO. So, as an example, if you wanted to localize
126 126  
127 -> Project->Components->Main WO
127 +>Project->Components->Main WO
128 128  
129 -You would right-click->Refactor->Move it to
129 +You would right-click->Refactor->Move it to
130 130  
131 -> Project->Resources->English.lproj->Main WO
131 +>Project->Resources->English.lproj->Main WO
132 132  
133 -and then right-click->Copy it from English.lproj and right-click->Paste it into Japanese.lproj. At this point, when you open the component in WOLips, there will be a tab at the bottom of the component editor view that allows you to switch back and forth between different localized versions of that component.
133 +and then right-click->Copy it from English.lproj and right-click->Paste it into Japanese.lproj. At this point, when you open the component in WOLips, there will be a tab at the bottom of the component editor view that allows you to switch back and forth between different localized versions of that component.
134 134  
135 135  Your layout would end up something like this:
136 136  
137 -[[image:ERXLocalizerEclipseLayout.png]]
137 +[[image:attach:ERXLocalizerEclipseLayout.png]]
138 138  
139 139  ===== Localized EOAttributes =====
140 140  
141 -In Wonder, it is also possible to localize attributes. There are two requisites:
141 +In Wonder, it is also possible to localize attributes. Let's say we have an entity //Blog// with an attribute //content// that we want to localize. This will be realized by not creating a column //content// in the database but a column for each specified language we want i.e. //content_en//, //content_fr//, ...
142 142  
143 -First add ERXLanguages to your Properties file:
143 +To tell EOF that we want a specific attribute localized you have to add a key ERXLanguages to its user info.
144 144  
145 -{{noformat}}
145 +[[image:attach:ERXLocalizerUserInfo_correct.png]]
146 146  
147 +In this example we set the type to //Array// and add an item for each needed language setting its value to the language code. This must be done for each attribute in our model we want to localize. If you have many localized attributes that have the very same list of languages and you will likely be changing that list in the future you can define your language list either for a whole model or for all models instead. The first way to specify a per model language list is to put an ERXLanguages key into the user info of the model. For a global setting put that key into your property file:
148 +
149 +{{noformat}}
147 147  ERXLanguages = (en,jp,fr_ca)
148 148  
149 149  {{/noformat}}
150 150  
151 -Then, for the attribute you'd like to localize, add the ERXLanguages key to the UserInfo for that specific attribute:
154 +All attributes that should use those global settings must have a key //ERXLanguages// in their user info with a type **different** to //Array//. Its value can be anything as only the presence of the key is of importance. The order that the languages are applied to an attribute is:
152 152  
153 -[[image:ERXLocalizerUserInfo.png]]
156 +* attribute user info with an array for ERXLanguages
157 +* if type of found user info is not an array then get array from key ERXLanguages from user info of the model
158 +* if user info of the model has no key ERXLanguages look for a property ERXLanguages in your property files
159 +* if no property ERXLanguages is found ignore localization
154 154  
155 155  ===== Direct Actions =====
156 156  
157 -If you are defaulting to direct actions, you may not have a session. If you do not have a session, the server will return the default language specified in the Properties mentioned above. If you're using direct actions and you don't like that behavior, you can stick this in your direct action class:
163 +If you are defaulting to direct actions, you may not have a session. If you do not have a session, the server will return the default language specified in the Properties mentioned above. If you're using direct actions and you don't like that behavior, you can stick this in your direct action class:
158 158  
159 159  {{code}}
160 -
161 - @Override
166 +@Override
162 162   public WOActionResults performActionNamed(String actionName) {
163 163   if(!context().hasSession()) {
164 164   ERXLocalizer localizer =
... ... @@ -168,17 +168,22 @@
168 168   return super.performActionNamed(actionName);
169 169   }
170 170  
171 -
172 172  {{/code}}
173 173  
174 -That should give the user their browser's default language setting instead of your server's default language setting until a session is created.
178 +That should give the user their browser's default language setting instead of your server's default language setting until a session is created.
175 175  
176 -[[^LocalizerTest.zip]] is an example application demonstrating the sessionless use of the localizer with localized strings and localized components, storing the language state in a cookie.
180 +[[attach:WO.Development-Localization and Internationalization@LocalizerTest.zip]] is an example application demonstrating the sessionless use of the localizer with localized strings and localized components, storing the language state in a cookie.
177 177  
178 178  ===== Database setup =====
179 179  
180 -Outside of this, if you are using a database, you'll need to make sure that is encoded properly as well. I'm using MySQL, so I have in my EOModel:
184 +Outside of this, if you are using a database, you'll need to make sure that is encoded properly as well. I'm using MySQL, so I have in my EOModel:
181 181  
182 182  jdbc:mysql:~/~/localhost/mydatabase?capitalizeTypenames=true&zeroDateTimeBehavior=convertToNull&characterEncoding=UTF-8
183 183  
184 -The database itself is set to default to "UTF8" encoding. (No hyphen in UTF8 for MySQL) You can set that in the "Options" pane of MySQL Administrator.app under the "Advanced" popup menu item in the "Def. char set" field. Of course, you'll need to use the correct database types too, meaning don't use a blob for text storage. Use varchar and longtext (varcharLarge is the name of the Wonder prototype) instead.
188 +The database itself is set to default to "UTF8" encoding. (No hyphen in UTF8 for MySQL) You can set that in the "Options" pane of MySQL Administrator.app under the "Advanced" popup menu item in the "Def. char set" field. Of course, you'll need to use the correct database types too, meaning don't use a blob for text storage. Use varchar and longtext (varcharLarge is the name of the Wonder prototype) instead.
189 +
190 +===== Localization presentation from WOWODC West 2009 =====
191 +
192 +Guido Neitzer did a localization presentation at WOWODC West 2009 that give a good overview of how to localize your apps. The presentation is available [[here>>url:http://www.wocommunity.org/podcasts/wowodc/west09/WOWODC09W-Localization.mov||shape="rect"]].
193 +
194 +