Greetings, There is a number of ApplicationResources_xx.properties in XWiki and it looks like all of them are different (contain different set of keys). Both ApplicationResources.properties and ApplicationResources_en.properties are in english and are mostly identical except for ~70 missing keys in _en file. Given that, I have two questions: 1. What is the "most supported" message resources file? 2. Are all messages from .properties used in XWiki, or some are redundant? If the latter, are there plans for removal of unnecessary keys for 1.0release? -- Best regards, Pavel
On Mar 24, 2007, at 10:55 PM, Pavel wrote:
Greetings,
There is a number of ApplicationResources_xx.properties in XWiki and it looks like all of them are different (contain different set of keys). Both ApplicationResources.properties and ApplicationResources_en.properties are in english and are mostly identical except for ~70 missing keys in _en file.
Given that, I have two questions: 1. What is the "most supported" message resources file?
ApplicationResources.properties 1) When a key is missing it's looked for in AppliationResources.properties. This allows any language to work even if there are missing keys. 2) I don't know why we have a AppplicationResources_en.properties as it's supposed to be the same as ApplicationResources.properties. IMO we should remove it
2. Are all messages from .properties used in XWiki, or some are redundant?
It's possible that some messages are no longer used.
If the latter, are there plans for removal of unnecessary keys for 1.0 release?
Sure, if you want to help you can tell us which ones are no longer used, submit a patch and we'll remove them. Note that we also have some work to do in the future on the message to use sentences instead of just words. This will allow languages not using the same word ordering than enlglish to provide a translation for XWiki. Thanks -Vincent
On 3/25/07, Vincent Massol <[email protected]> wrote:
On Mar 24, 2007, at 10:55 PM, Pavel wrote:
Greetings,
There is a number of ApplicationResources_xx.properties in XWiki and it looks like all of them are different (contain different set of keys). Both ApplicationResources.properties and ApplicationResources_en.properties are in english and are mostly identical except for ~70 missing keys in _en file.
Given that, I have two questions: 1. What is the "most supported" message resources file?
ApplicationResources.properties
Indeed, with a minor observation that a few entries in AR_en.properties override the ones in AR.properties. 1) When a key is missing it's looked for in
AppliationResources.properties. This allows any language to work even if there are missing keys. 2) I don't know why we have a AppplicationResources_en.properties as it's supposed to be the same as ApplicationResources.properties. IMO we should remove it
In theory, if somebody decides to deploy a wiki mainly used in russian, for example, he could replace AR.properties with AR_ru.properties as the default resource bundle. The, in order for the english translation to work, AR_en.properties should exist. However, maintaining two resource files is not needed, as if someone knows how to replace AR.properties, he should know how to create the backup AR_en.properties. In an ideal world (to be read: a world without Microsoft and Windows) AR.props should be a symlink to the actual language file. So, +1 for removing AR_en.properties.
2. Are all messages from .properties used in XWiki, or some are
redundant?
It's possible that some messages are no longer used.
Almost all messages are used, but in different skins. One thing we can do to ease the work would be to copy the current resource files into the dodo skin directory, and declare it as deprecated, so that we can move on with the new skins.
If the latter, are there plans for removal of unnecessary keys for
1.0 release?
Sure, if you want to help you can tell us which ones are no longer used, submit a patch and we'll remove them.
Note that we also have some work to do in the future on the message to use sentences instead of just words. This will allow languages not using the same word ordering than enlglish to provide a translation for XWiki.
Is there a JIRA issue for this? I remember seeing this, but I don't know if it was in a mail only, or on JIRA, too. Thanks
-Vincent
Vincent, Sergui, So as I understand, the translation process for message resources should be as follows: 1. Copy AR.properties, add language-specific suffix. 2. Translate messages into specific language. 3. Watch the result, adjust messages as necessary. This is a continuous process. 4. If some obstacles found, like hardcoded message structure which does not fit the language, then a) Create JIRA issue b) Preferably submit a patch (5). Contribute translation back to XWiki to ensure at least minimal support & synchronization with other bundles Item 5 is just a guess as I have no idea about how XWiki deals with contributions of that kind. Speaking about removal of unused keys, I believe it can be done only by experienced XWiki developer. Doing that without a good knowledge of all possible resource usage patterns inevitably leads to a broken areas in application. At least that's what I've seen before. On 3/26/07, Sergiu Dumitriu <[email protected]> wrote:
On 3/25/07, Vincent Massol <[email protected]> wrote:
On Mar 24, 2007, at 10:55 PM, Pavel wrote:
Greetings,
There is a number of ApplicationResources_xx.properties in XWiki and it looks like all of them are different (contain different set of keys). Both ApplicationResources.properties and ApplicationResources_en.properties are in english and are mostly identical except for ~70 missing keys in _en file.
Given that, I have two questions: 1. What is the "most supported" message resources file?
ApplicationResources.properties
Indeed, with a minor observation that a few entries in AR_en.properties override the ones in AR.properties.
1) When a key is missing it's looked for in
AppliationResources.properties . This allows any language to work even if there are missing keys. 2) I don't know why we have a AppplicationResources_en.properties as it's supposed to be the same as ApplicationResources.properties. IMO we should remove it
In theory, if somebody decides to deploy a wiki mainly used in russian, for example, he could replace AR.properties with AR_ru.properties as the default resource bundle. The, in order for the english translation to work, AR_en.properties should exist.
However, maintaining two resource files is not needed, as if someone knows how to replace AR.properties, he should know how to create the backup AR_en.properties.
In an ideal world (to be read: a world without Microsoft and Windows) AR.props should be a symlink to the actual language file.
So, +1 for removing AR_en.properties.
2. Are all messages from .properties used in XWiki, or some are
redundant?
It's possible that some messages are no longer used.
Almost all messages are used, but in different skins. One thing we can do to ease the work would be to copy the current resource files into the dodo skin directory, and declare it as deprecated, so that we can move on with the new skins.
If the latter, are there plans for removal of unnecessary keys for
1.0 release?
Sure, if you want to help you can tell us which ones are no longer used, submit a patch and we'll remove them.
Note that we also have some work to do in the future on the message to use sentences instead of just words. This will allow languages not using the same word ordering than enlglish to provide a translation for XWiki.
Is there a JIRA issue for this? I remember seeing this, but I don't know if it was in a mail only, or on JIRA, too.
Thanks
-Vincent
-- You receive this message as a subscriber of the [email protected] list. To unsubscribe: mailto:[email protected] For general help: mailto:[email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
-- Best regards, Pavel
On Mar 26, 2007, at 12:48 AM, Pavel wrote:
Vincent, Sergui,
So as I understand, the translation process for message resources should be as follows:
1. Copy AR.properties, add language-specific suffix.
No need to do any copy... By default if a message is not found in the resource bundle for the country/language it looks for it in the default resource bundle (AR.properties). Recommendation: use a proper IDE like Eclipse or even better IDEA. They have support for resource bundle and make it real easy to spot inconsistencies.
2. Translate messages into specific language.
Yes
3. Watch the result, adjust messages as necessary. This is a continuous process.
Yes
4. If some obstacles found, like hardcoded message structure which does not fit the language, then a) Create JIRA issue b) Preferably submit a patch
Yes
(5). Contribute translation back to XWiki to ensure at least minimal support & synchronization with other bundles
Yes
Item 5 is just a guess as I have no idea about how XWiki deals with contributions of that kind.
See the contributing guide on xwiki.org. They're welcome :)
Speaking about removal of unused keys, I believe it can be done only by experienced XWiki developer. Doing that without a good knowledge of all possible resource usage patterns inevitably leads to a broken areas in application. At least that's what I've seen before.
True, but it's not much easier for any xwiki developers as nobody knows where messages are used from. It's a search and replace strategy (at least that's what it would be for me). And then do testing to verify nothing is broken. Thanks -Vincent
On 3/26/07, Sergiu Dumitriu <[email protected]> wrote:
On 3/25/07, Vincent Massol < [email protected]> wrote:
On Mar 24, 2007, at 10:55 PM, Pavel wrote:
Greetings,
There is a number of ApplicationResources_xx.properties in XWiki and it looks like all of them are different (contain different set of keys). Both ApplicationResources.properties and ApplicationResources_en.properties are in english and are mostly identical except for ~70 missing keys in _en file.
Given that, I have two questions: 1. What is the "most supported" message resources file?
ApplicationResources.properties
Indeed, with a minor observation that a few entries in AR_en.properties override the ones in AR.properties.
1) When a key is missing it's looked for in AppliationResources.properties . This allows any language to work even if there are missing keys. 2) I don't know why we have a AppplicationResources_en.properties as it's supposed to be the same as ApplicationResources.properties. IMO we should remove it
In theory, if somebody decides to deploy a wiki mainly used in russian, for example, he could replace AR.properties with AR_ru.properties as the default resource bundle. The, in order for the english translation to work, AR_en.properties should exist.
However, maintaining two resource files is not needed, as if someone knows how to replace AR.properties, he should know how to create the backup AR_en.properties.
In an ideal world (to be read: a world without Microsoft and Windows) AR.props should be a symlink to the actual language file.
So, +1 for removing AR_en.properties.
2. Are all messages from .properties used in XWiki, or some are redundant?
It's possible that some messages are no longer used.
Almost all messages are used, but in different skins. One thing we can do to ease the work would be to copy the current resource files into the dodo skin directory, and declare it as deprecated, so that we can move on with the new skins.
If the latter, are there plans for removal of unnecessary keys for 1.0 release?
Sure, if you want to help you can tell us which ones are no longer used, submit a patch and we'll remove them.
Note that we also have some work to do in the future on the message to use sentences instead of just words. This will allow languages not using the same word ordering than enlglish to provide a translation for XWiki.
Is there a JIRA issue for this? I remember seeing this, but I don't know if it was in a mail only, or on JIRA, too.
Thanks -Vincent
-- You receive this message as a subscriber of the xwiki- [email protected] mailing list. To unsubscribe: mailto: [email protected] For general help: mailto: [email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/ wws
-- Best regards, Pavel
-- You receive this message as a subscriber of the xwiki- [email protected] mailing list. To unsubscribe: mailto:[email protected] For general help: mailto:[email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/ wws
On Mar 25, 2007, at 11:54 PM, Sergiu Dumitriu wrote:
On 3/25/07, Vincent Massol <[email protected]> wrote:
On Mar 24, 2007, at 10:55 PM, Pavel wrote:
Greetings,
There is a number of ApplicationResources_xx.properties in XWiki and it looks like all of them are different (contain different set of keys). Both ApplicationResources.properties and ApplicationResources_en.properties are in english and are mostly identical except for ~70 missing keys in _en file.
Given that, I have two questions: 1. What is the "most supported" message resources file?
ApplicationResources.properties
Indeed, with a minor observation that a few entries in AR_en.properties override the ones in AR.properties.
1) When a key is missing it's looked for in AppliationResources.properties . This allows any language to work even if there are missing keys. 2) I don't know why we have a AppplicationResources_en.properties as it's supposed to be the same as ApplicationResources.properties. IMO we should remove it
In theory, if somebody decides to deploy a wiki mainly used in russian, for example, he could replace AR.properties with AR_ru.properties as the default resource bundle.
AFAIK there's no default resource bundle. Or rather there's one but it's always named without the country and language suffixes. Unless I'm mistaken of course :)
The, in order for the english translation to work, AR_en.properties should exist.
However, maintaining two resource files is not needed, as if someone knows how to replace AR.properties, he should know how to create the backup AR_en.properties.
In an ideal world (to be read: a world without Microsoft and Windows) AR.props should be a symlink to the actual language file.
So, +1 for removing AR_en.properties.
2. Are all messages from .properties used in XWiki, or some are redundant?
It's possible that some messages are no longer used.
Almost all messages are used, but in different skins. One thing we can do to ease the work would be to copy the current resource files into the dodo skin directory, and declare it as deprecated, so that we can move on with the new skins.
It makes sense to me that AR files should be in their own skins, except for messages for templates.
If the latter, are there plans for removal of unnecessary keys for 1.0 release?
Sure, if you want to help you can tell us which ones are no longer used, submit a patch and we'll remove them.
Note that we also have some work to do in the future on the message to use sentences instead of just words. This will allow languages not using the same word ordering than enlglish to provide a translation for XWiki.
Is there a JIRA issue for this? I remember seeing this, but I don't know if it was in a mail only, or on JIRA, too.
No idea... Thanks -Vincent
participants (3)
-
Pavel -
Sergiu Dumitriu -
Vincent Massol