Practical Internationalization Improvement for Sakai CLE

Practical Internationalization Improvement for Sakai CLEJean-François Lévêque, Developer, UPMC with content from Beth Kirschner, i18n/L10n contributors and developers

P.I.I. definition (from Wiktionary)● Practical ● Based on practice or action rather than theory or hypothesis● Internationalization ● The act or process of making a product suitable for international markets● Improvement ● The act of improving; advancement or growth; promotion in desirable qualities; progress toward what is better; melioration● Sakai CLE only? I dont know OAE much. 12th Sakai Conference – Los Angeles, California – June 14-16 2

Internationalization andlocalization (from Wikipedia)● means of adapting computer software to different languages, regional differences and technical requirements of a target market● Internationalization (i18n) ● process of designing a software application so that it can be adapted to various languages and regions without engineering changes● Localization (L10n) ● process of adapting internationalized software for a specific region or language by adding locale- specific components and translating text 12th Sakai Conference – Los Angeles, California – June 14-16 3

Whats in a locale?● Language (ISO Language Code) ● ar, eu, ca, zh, nl, en, fr, ja, ko, pt, ru, es, sv, tr, vi● Country (ISO Country Code) ● ES, CN, TW, NL, AU, NZ, ZA, GB, US, CA, FR, JP, KR, BR, PT, RU, SE, TR, VN● Variant (free) ● DEBUG (in en_US_DEBUG)● Check java.util.Locale for more 12th Sakai Conference – Los Angeles, California – June 14-16 4

CLE focal i18n points (my choice)● Alphabets/scripts: Unicode with UTF-8● Writing direction: customized skins or CSS● Graphical representations of text: to avoid● Date/time format● Time zones● Formatting of numbers● Displayable strings● https://confluence.sakaiproject.org/display/I18N/Ho me (for more) 12th Sakai Conference – Los Angeles, California – June 14-16 5

Date/time with TZ and numbers● Localize Date & Time ● Output: java.text.DateFormat (has Time Zone) ● Input (dont forget the Time Zone): – java.text.DateFormats parse – Date/time widget with i18n● Localize numbers ● Output: java.text.NumberFormat/DecimalFormat ● Input: java.text.NumberFormat/DecimalFormats parse 12th Sakai Conference – Los Angeles, California – June 14-16 6

Displayable strings● Use org.sakaiproject.util.ResourceLoader● Static phrases: ● language based text should be localized into a properties file● Dynamic phrases: ● still in properties file ● use getFormattedMessage ● structure messages appropriately 12th Sakai Conference – Los Angeles, California – June 14-16 7

Other strings● Properties files (<filename>.properties) should only be used for user interface text that should be translated. ● All other configuration information (e.g. configuration constants, class names, filenames, etc.) should be in a separate directory tree. ● Alternately, config files can use the <filename>.config extension● Properties files should not have mixed content and contain explicit information about their content. This information should be also provided in the tool documentation. 12th Sakai Conference – Los Angeles, California – June 14-16 8

Sample .properties entries● shortenedurl/impl/src/java/url.properties ● url = An entity provider to allow shortening of URLs via the ShortenedUrlService● samigo/samigo- app/src/java/org/sakaiproject/tool/assessment/b undle/EvaluationMessages.properties ● paging_status=Viewing {0} - {1} of {2} items 12th Sakai Conference – Los Angeles, California – June 14-16 9

More about i18n .properties● Do not keep unused key/value pairs● Double check you dont concatenate strings● Do not use several keys for the same value● Please reuse labels (button, tool name ...) when used in other strings● Do not use the to escape the line terminator sequence in properties files. This is a source of human errors, prevents sorting and is not compatible with lois l10n-stats currently used in http://qa1-nl.sakaiproject.org/international/ 12th Sakai Conference – Los Angeles, California – June 14-16 10

Use in Java code● Static phrase ResourceLoader rb = new ResourceLoader("_org.sakaiproject.tool.foobar .bundle.Messages_"); String foo = rb.getString("foo");● Dynamic phrase String s =rb.getFormattedMessage("event.syllabus.de lete", new Object[] {syllabusData.getTitle(),siteId}); 12th Sakai Conference – Los Angeles, California – June 14-16 11

Use in JSF based tools● Static phrase <h:outputText value="#{msgs.foo}"/>● Dynamic phrase <h:outputFormat value="#{msgs.lay_restricted_note_messages}" rendered="#{ChatTool.canRenderNumberMessages} ">● Use Sakai CLEs ResourceLoader for i18n bundles 12th Sakai Conference – Los Angeles, California – June 14-16 12

Use in JSP based tools (1/2)● Use Sakai CLEs ResourceLoader to get the locale and load bundles <jsp:useBean id="msgs" class="org.sakaiproject.util.ResourceLoader" scope="session"> <jsp:setProperty name="msgs" property="baseName" value="messages"/> </jsp:useBean> 12th Sakai Conference – Los Angeles, California – June 14-16 13

Use in JSP based tools (2/2)● Static phrase <c:out value="${msgs.foo}"/>● Dynamic phrase <fmt:message key="message_permissionsEdit"> <fmt:param><c:out value="$ {tool.title}"/></fmt:param> <fmt:param><c:out value="$ {worksite.title}"/></fmt:param> </fmt:message> 12th Sakai Conference – Los Angeles, California – June 14-16 14

Use in Velocity based tools● Pass Sakai CLEs ResourceLoader to your velocity template ResourceLoader rb = new ResourceLoader("_org.sakaiproject.tool.foobar.bun dle.Messages_"); context.put("tlang", rb );● Static string $tlang.getString("foo");● Dynamic string $tlang.getFormattedMessage("foo", $value); 12th Sakai Conference – Los Angeles, California – June 14-16 15

Use in RSF based tools (1/2)● Use CLEs ResourceLoaderMessageSource<bean id="messageSource"class="org.sakaiproject.util.ResourceLoaderMessageSource"><property name="basename"value="classpath:org/sakaiproject/site/tool/participant/bundle/sitesetupgeneric"/><property name="cacheSeconds" value="10" /></bean> 12th Sakai Conference – Los Angeles, California – June 14-16 16

Use in RSF based tools (2/2) ● Static string UIMessage.make(tofill, "my-rsf-id", "page.user.message.key"); ● Dynamic string UIMessage.make(tofill, "modify-template- header", "modifyemail.modify.template.header", new Object[] {headerName}); 12th Sakai Conference – Los Angeles, California – June 14-16 17

Use in Wicket based tools (1/2)● Implement your own ResourceLoader to take advantage of Sakai CLEs ResourceLoader● Set it up in your WebApplication init method getResourceSettings().addStringResourceLoa der(new MyStringResourceLoader()); 12th Sakai Conference – Los Angeles, California – June 14-16 18

Use in Wicket based tools (2/2)● Static string <wicket:message key="some.message.key" /> or <table wicket:message="summary:my.great.table.message.key">● Dynamic string (works for static too) Label myLabel = new Label("myLabel", new StringResourceModel("some.message.key.with.params", null, new Object[]{ value1, value2 } )); someComponent.add(myLabel); 12th Sakai Conference – Los Angeles, California – June 14-16 19

Use in Javascript based tools● http://tinyurl.com/yhora2v● In a nutshell ● Use EntityBroker to call ResourceLoader, use Fluid Infusion, call the EntityProvider via AJAX request● Static string var removalString = fluid.messageLocator( messageBundle ) (["administrate.general.enable.response.removal"]);● Dynamic string var removalString = fluid.messageLocator( messageBundle ) (["removeitem.removed.user.message"], 3 ); 12th Sakai Conference – Los Angeles, California – June 14-16 20

Use in Google Web Toolkit (GWT) based tools● GWT has its own i18n dev guide● Integrating GWT tools with Sakai CLE Internationalization is still a work in progress● No code using GWT in the official Sakai CLE so far 12th Sakai Conference – Los Angeles, California – June 14-16 21

Use in other frameworks● If other frameworks are used, further documentation should be provided● Trimpath documentation has started recently 12th Sakai Conference – Los Angeles, California – June 14-16 22

Static HTML files● Provide automatic loading of translated files when provided (variant, country, language) for set locale (server_info_ja.html instead of server_info.html)● Provide a documented debug file giving translation instructions (webcontent_instructions_en_US_DEBUG.html for webcontent_instructions.html) 12th Sakai Conference – Los Angeles, California – June 14-16 23

What else should I do?● Document your i18n ● List all the i18n properties files ● List all the other files (HTML, XML, ...) that have static or dynamic text which is displayed and explain how to translate them ● Document the way youre doing i18n if its not documented in: https://confluence.sakaiproject.org/display/I18N ● Answer “Am I using Sakais ResourceLoader?” 12th Sakai Conference – Los Angeles, California – June 14-16 24

Why should I use Sakai CLEs ResourceLoader?● Provided en_US_DEBUG locale helps translation, otherwise you should mimic it● Compatibility with the contrib message bundle editing tool 12th Sakai Conference – Los Angeles, California – June 14-16 25

What else can I do?● Please use EmailTemplateService to enable translation of whole emails with dynamic parts● Check if you use the same strings as another tool. ● If its the case, contact me about shared i18n. 12th Sakai Conference – Los Angeles, California – June 14-16 26

How good is my tool?● If its part of the official release ● Check for reported i18n issues https://confluence.sakaiproject.org/display/SPANISH/i18n+tools+status ● Ask for a review by volunteers on i18n list● If its in contrib ● And JIRA: ask for inclusion in i18n report ● Review by volunteers is also possible● Need help? Please ask 12th Sakai Conference – Los Angeles, California – June 14-16 27

Practical Internationalization Improvement for Sakai CLE

by jfl_101010

Accessibility

Categories

Upload Details

Usage Rights

2 Embeds 19

Statistics

Practical Internationalization Improvement for Sakai CLE Presentation Transcript

http://www.slideshare.net	18
https://confluence.sakaiproject.org	1