Changes for page Development-Localization and Internationalization

Last modified by Pascal Robert on 2015/05/04 04:24

From 54.1 to 53.1 From 59.1 to 58.1

From version 58.1

edited by Pascal Robert
on 2012/02/11 08:39

Change comment: There is no comment for this version

To version 54.1

edited by Ramsey Gurley
on 2010/02/02 23:01

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Development-Localization and Internationalization
++Web Applications-Development-Localization and Internationalization

Author

@@ -1,1 +1,1 @@
--XWiki.probert
++XWiki.ramsey

Content

@@ -1,6 +1,6 @@
  == Unicode ==
--See also: [[UTF-8 Encoding Tips>>doc:UTF-8 Encoding Tips]]
++See also: [[UTF-8 Encoding Tips]]
  To Enable Unicode for your WO app, add the following to your application constructor:
@@ -14,7 +14,7 @@
  Then you just need to tell the browser. Make all your .wo pages include this meta tag in their HTML:
--{{code 0="xml"}}
++{{code value="xml"}}
  <html>
  <head>
@@ -64,23 +64,23 @@
  {{/code}}
--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.
++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.
  With Jesse's code and this extension, you will be able to handle UTF-8 character data correctly in your WO application.
--If you use localized strings in your UTF-8 application you may also check out Project Wonder's [[ERXLocalizer>>doc:WOnder-ERXLocalizer]] class.
++If you use localized strings in your UTF-8 application you may also check out Project Wonder's [[ERXLocalizer>>WOnder-ERXLocalizer]] class.
--=== Project Localization tips ===
++=== Project Localization tips  [[~~ramsey]] ===
  The following are some tips and suggestions for localizing a project in WOLips using Project Wonder.
  ===== Eclipse Default Encoding =====
--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.
++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.
  ===== Properties file =====
--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:
++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:
  {{noformat}}
@@ -103,8 +103,8 @@
  {{/noformat}}
--(% style="color: rgb(51,51,51);" %)The other changes are then in the er.extensions.ERXLocalizer.availableLanguages and ERXLanguages:(%%)
-- (% style="color: rgb(51,51,51);" %)In the above case after adding canadian french these would change in:
++The other changes are then in the  er.extensions.ERXLocalizer.availableLanguages and ERXLanguages:
++In the above case after adding canadian french these would change in:
  {{noformat}}
@@ -112,48 +112,36 @@
  {{/noformat}}
--(% style="color: rgb(51,51,51);" %)Localized formatters use this property:
--
--{{noformat}}
--
--er.extensions.ERXLocalizer.useLocalizedFormatters=false
--
--{{/noformat}}
--
  ===== Localized strings and components =====
--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:
++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:
-->Project->Resources->English.lproj->Localizable.strings
--> Project->Resources->Japanese.lproj->Localizable.strings
--> Project->Resources->French_CA.lproj->Localizable.strings
++Project->Resources->English.lproj->Localizable.strings
++Project->Resources->Japanese.lproj->Localizable.strings
++Project->Resources->French//CA.lproj->Localizable.strings//
--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.
++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.
--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
++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
-->Project->Components->Main WO
++> Project->Components->Main WO
--You would right-click->Refactor->Move it to
++You would right-click->Refactor->Move it to
-->Project->Resources->English.lproj->Main WO
++> Project->Resources->English.lproj->Main WO
--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.
++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.
  Your layout would end up something like this:
--[[image:attach:ERXLocalizerEclipseLayout.png]]
++[[image:ERXLocalizerEclipseLayout.png]]
  ===== Localized EOAttributes =====
--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//, ...
++In Wonder, it is also possible to localize attributes. There are two requisites:
--To tell EOF that we want a specific attribute localized you have to add a key ERXLanguages to its user info.
++First add ERXLanguages to your Properties file:
--[[image:attach:ERXLocalizerUserInfo_correct.png]]
--
--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:
--
  {{noformat}}
  ERXLanguages = (en,jp,fr_ca)
@@ -160,20 +160,17 @@
  {{/noformat}}
--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:
++Then, for the attribute you'd like to localize, add the ERXLanguages key to the UserInfo for that specific attribute:
--* attribute user info with an array for ERXLanguages
--* if type of found user info is not an array then get array from key ERXLanguages from user info of the model
--* if user info of the model has no key ERXLanguages look for a property ERXLanguages in your property files
--* if no property ERXLanguages is found ignore localization
++[[image:ERXLocalizerUserInfo.png]]
  ===== Direct Actions =====
--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:
++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:
  {{code}}
--@Override
++	@Override
  	public WOActionResults performActionNamed(String actionName) {
  		if(!context().hasSession()) {
  			ERXLocalizer localizer =
@@ -183,22 +183,17 @@
  		return super.performActionNamed(actionName);
  	}
++
  {{/code}}
--That should give the user their browser's default language setting instead of your server's default language setting until a session is created.
++That should give the user their browser's default language setting instead of your server's default language setting until a session is created.
--[[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.
++[[^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.
  ===== Database setup =====
--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:
++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:
  jdbc:mysql:~/~/localhost/mydatabase?capitalizeTypenames=true&zeroDateTimeBehavior=convertToNull&characterEncoding=UTF-8
--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.
--
--===== Localization presentation from WOWODC West 2009 =====
--
--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/WOWODCW09-Localization.mov||shape="rect"]].
--
--
++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.

Changes for page Development-Localization and Internationalization

Summary

Details

Applications

Navigation

My Recent Modifications

Need help?