topic Re: Internationalization template strings in Alfresco Archive

Internationalization template strings

ribz33 — Thu, 30 Nov 2006 10:24:13 GMT

hi,how i can make a freemarker template multilingual ?Im using template for dashlet and i want to internationalize it how i can do it ?i had trieed this : ${message(product_name)}‍ for instance but its not working.

Re: Internationalization template strings

kevinr — Thu, 30 Nov 2006 11:46:07 GMT

Something like this should work:


${message("product_name")}
‍‍‍

note the quotes around the I18N message string name.

The Templating engine executes with the repository context - so it does not have access to the webclient.properties I18N message bundle. Instead it only has access to the registered repository bundles as defined here:
config/alfresco/core-services-context.xml
in this section


    <!–                        –>
    <!– I18N                   –>
    <!–                        –>

    <bean id="resourceBundles" class="org.alfresco.i18n.ResourceBundleBootstrapComponent">
       <property name="resourceBundles">
          <list>
             <value>alfresco.messages.system-messages</value>
             <value>alfresco.messages.dictionary-messages</value>
             <value>alfresco.messages.version-service</value>
             <value>alfresco.messages.permissions-service</value>
             <value>alfresco.messages.content-service</value>
             <value>alfresco.messages.coci-service</value>
             <value>alfresco.messages.template-service</value>
             <value>alfresco.messages.lock-service</value>
             <value>alfresco.messages.patch-service</value>
             <value>alfresco.messages.schema-update</value>
             <value>alfresco.messages.webdav-messages</value>
             <value>alfresco.messages.copy-service</value>
          </list>
       </property>
    </bean>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

So you can add your message bundle to this list using the extension mechanism if you don't want to edit the original file.

Thanks,

Kevin

Re: Internationalization template strings

ribz33 — Thu, 30 Nov 2006 12:38:36 GMT

Thx a lot its very clear

Re: Internationalization template strings

ribz33 — Fri, 01 Dec 2006 09:51:33 GMT

Ok its working well, i have just a little bug on dashboard !

After connect, template in dashlet don't use right language, but if i refresh page i see good one.

I see always French language on connect although i choose English in login box. If i clic on my Alfresco, page is refreshed and i see English in dashlet.

If you know why im interested in.

Re: Internationalization template strings

kevinr — Fri, 01 Dec 2006 09:57:29 GMT

That does sound like a bug - please raise it in JIRA.

Thanks,

Kevin

Re: Internationalization template strings

ribz33 — Fri, 01 Dec 2006 10:24:05 GMT

Ok, ticket is done :
http://issues.alfresco.com/browse/AWC-1038

thx Kevin

Re: Internationalization template strings

zummy — Wed, 20 Dec 2006 09:41:06 GMT

Hi Kevin,

I'm a newbie and there are things I'm still do not fully understand.

For a custom action I have added I would like to setup a label-id. So I've done the following:

- create a custom-services-context.xml in alfresco/extension with the following:
<beans>
    <bean id="resourceBundles" class="org.alfresco.i18n.ResourceBundleBootstrapComponent">
       <property name="resourceBundles">
          <list>
             <value>alfresco.messages.webclient-custom</value>
          </list>
       </property>
    </bean>
</beans>

- add a new webclient-custom.properties file in alfresco/messages

But it does not work. When I re-launch the jBoss server it raises tons of errors. What's wrong with that?

Thks in advance,
Christophe

Re: Internationalization template strings

ribz33 — Wed, 20 Dec 2006 09:47:21 GMT

try this maybe :


    <bean id="resourceBundles" class="org.alfresco.i18n.ResourceBundleBootstrapComponent">
       <property name="resourceBundles">
          <list>
             <value>alfresco.messages.webclient-custom</value>
 
             <value>alfresco.messages.system-messages</value>
             <value>alfresco.messages.dictionary-messages</value>
             <value>alfresco.messages.version-service</value>
             <value>alfresco.messages.permissions-service</value>
             <value>alfresco.messages.content-service</value>
             <value>alfresco.messages.coci-service</value>
             <value>alfresco.messages.template-service</value>
             <value>alfresco.messages.lock-service</value>
             <value>alfresco.messages.patch-service</value>
             <value>alfresco.messages.schema-update</value>
             <value>alfresco.messages.webdav-messages</value>
             <value>alfresco.messages.copy-service</value>
          </list>
       </property>
    </bean> 
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

me its working like this

Re: Internationalization template strings

zummy — Wed, 20 Dec 2006 09:55:07 GMT

Hi ribz33,

I've done what you say and now the server starts correctly. Thks. But on the other hand, Alfresco doesn't seem to find out the resource bundle. I'm running on jBoss server and I've put the properties file in C:\alfresco\jboss\server\default\conf\alfresco\messages

Is it the right place to put this file? I thought this directory was in the classpath…

Sorry for all these stupid questions. Thanks again.
Christophe

Re: Internationalization template strings

ribz33 — Wed, 20 Dec 2006 10:05:15 GMT

i think that would be good…
maybe try to move your properties file to extension

C:\alfresco\jboss\server\default\conf\alfresco\extension
dont forget to change :

<value>alfresco.extension.webclient-custom</value>‍

where you want to use this properties ? in a jsp ?
In this case you need to load bundle like it in your jsp code:

<f:loadBundle basename="alfresco.messages.webclient-custom" var="myMsg"/>‍

Re: Internationalization template strings

zummy — Wed, 20 Dec 2006 10:13:19 GMT

Merci ribz for the time you spend answering my question.

I've tried that but still does not work.

Actually I want to add a custom action in the "More Actions" menu so in the web-client-config-custom.xml I have added the following:

   <config>
      <actions>
         <action id="my_details_space">
               <label-id>generate_odj</label-id>
            <image>/images/icons/View_details.gif</image>
            <action-listener>#{BrowseBean.setupSpaceAction}</action-listener>
            <params>
               <param name="id">#{actionContext.id}</param>
            </params>
         </action>

         <action-group id="browse_actions_menu">
            <action idref="my_details_space" />
         </action-group>
      </actions>

   </config>

But the label appears as follow on the UI:
$$generate_odj$$

Re: Internationalization template strings

ribz33 — Wed, 20 Dec 2006 10:32:43 GMT

Ok that is different !

In your case you try to internationalize webclient and not core or special jsp.
In this case i don't know how we can define well string in an extension ressource bundle.

For webclient, me i code label directly in webclient.properties

I'm sorry i don't know how we can do it like extension.

You need help of alfresco engineers now to do that like you want.

And be careful if you add webclient.properties and webclient.properties_en_US i dont know why but for me alfresco don't overwrite well it. So i write it directly in WAR.

I know its not best way but its the only that i had found at the moment which is working ops:

Re: Internationalization template strings

gavinc — Tue, 09 Jan 2007 21:12:52 GMT

Hi,

To add a custom label in this way requires a "webclient.properties" to be placed in the alfresco.extension package.

If you are using JBoss this file should go in the directory mentioned by ribz33 i.e. in C:\alfresco\jboss\server\default\conf\alfresco\extension

The following wiki page explains the process: http://wiki.alfresco.com/wiki/Adding_Custom_I18N_Strings

Re: Internationalization template strings

robain — Wed, 24 Sep 2008 14:44:10 GMT

after setting the values in webclient.properties file, are they available on the freemarker templates as well ??
${message("product_name")}

Re: Internationalization template strings

dominique — Fri, 28 Nov 2008 16:17:10 GMT

Hi guys,

It IS possible (at least in Alfresco Labs 3C) to create differente message properties files, not using default webclient.properties.
And so making it easier to develop in larger teams and not interfere with translations.

After digging into the source code, I found out how:

You basically have 2 different beans dealing with messages:

1) the default Alfresco one:

This one uses:

org.alfresco.i18n.ResourceBundleBootstrapComponent

as defined and configured inside:

WEB-INF/classes/alfresco/core-services-context.xml

2) And the Webclient one:

org.alfresco.web.app.ResourceBundleBootstrap

(check out the src code of org.alfresco.web.app.ResourceBundleWrapper to find out more about it)

Webclient resources are loaded by this class, but it not defined yet in a normal Alfresco environment.
Instead, you have to define yourself.
So, if you want to use different webclient message files, you need to add them to the list.
So, create a file :

WEB-INF/classes/alfresco/extension/custom-webclient-context.xml

contents:

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>

<beans>

   <bean id="resourceBundlesWebApp" class="org.alfresco.web.app.ResourceBundleBootstrap">
      <property name="resourceBundles">
         <list>
             <value>alfresco.extension.custom-webclient</value>
         </list>
      </property>
   </bean>


</beans>

And then put you're properties into:

WEB-INF/classes/alfresco/extension/custom-webclient.properties

Now you're action labels etc will work !
For inside the JSP, you off course still have to load them like this
<f:loadBundle basename="alfresco.extension.custom-webclient" var="customMsg"/>

hope this helped!

Kind regards

Dominique De Munck