[xwiki-devs] [Proposal] Location of translation properties
Hi Devs, Even though we don’t have listed on http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices I believe the following has already been agreed but I’d like to add it there so I’m sending it as a proposal. So I propose that: * Any java code requiring translation should put them in an ApplicationResources.properties file at the root of the JAR (not the global ApplicationResources.properties in oldcore!) * Any wiki page requiring translations should put them in a Translations page in the space for the app. Special case: * For Macro UI modules (ie containing only wiki macros), we put them in the Macros space and in this case we should use a Macros.XXXTranslations page for each module. We’ll need to decide what we want to do in the future. Also, even if some existing module is wrongly using the ApplicationResources.properties in oldcore (for example), we should still follow the rules above and start doing it in the new way. WDYT? Thanks -Vincent
On 23 Feb 2015 at 16:42:21, [email protected] ([email protected](mailto:[email protected])) wrote:
Hi Devs,
Even though we don’t have listed on http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices I believe the following has already been agreed but I’d like to add it there so I’m sending it as a proposal.
So I propose that:
* Any java code requiring translation should put them in an ApplicationResources.properties file at the root of the JAR (not the global ApplicationResources.properties in oldcore!) * Any wiki page requiring translations should put them in a Translations page in the space for the app.
Special case: * For Macro UI modules (ie containing only wiki macros), we put them in the Macros space and in this case we should use a Macros.XXXTranslations page for each module. We’ll need to decide what we want to do in the future.
I meant that we’ll need to decide if we still consider that having this anonymous Macros space is a good thing or not, or if we should have for example dedicated spaces even in this case (with Macro translations, there should be no single page app for macros ;)).
Also, even if some existing module is wrongly using the ApplicationResources.properties in oldcore (for example), we should still follow the rules above and start doing it in the new way.
I meant: when we need to add new translations, we should still follow the rules above and start doing it in the new way. Thanks -Vincent
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Yes the translation should be part of the extension itself. Also don't forget to a new translation resource to http://l10.xwiki.org and the release script. On Mon, Feb 23, 2015 at 4:44 PM, [email protected] <[email protected]> wrote:
On 23 Feb 2015 at 16:42:21, [email protected] ([email protected](mailto:[email protected])) wrote:
Hi Devs,
Even though we don’t have listed on http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices I believe the following has already been agreed but I’d like to add it there so I’m sending it as a proposal.
So I propose that:
* Any java code requiring translation should put them in an ApplicationResources.properties file at the root of the JAR (not the global ApplicationResources.properties in oldcore!) * Any wiki page requiring translations should put them in a Translations page in the space for the app.
Special case: * For Macro UI modules (ie containing only wiki macros), we put them in the Macros space and in this case we should use a Macros.XXXTranslations page for each module. We’ll need to decide what we want to do in the future.
I meant that we’ll need to decide if we still consider that having this anonymous Macros space is a good thing or not, or if we should have for example dedicated spaces even in this case (with Macro translations, there should be no single page app for macros ;)).
Also, even if some existing module is wrongly using the ApplicationResources.properties in oldcore (for example), we should still follow the rules above and start doing it in the new way.
I meant: when we need to add new translations, we should still follow the rules above and start doing it in the new way.
Thanks -Vincent
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
Hi, Not all macros are in the Macros space. Actually this is quite a new thing and only a handful of macros follow this rule (although seems pretty decent). For example MapMacro or PDFViewerMacro are located in the XWiki space. Where do I put the translations file? XWiki.MapMacroTranslations and XWiki.PDFViewerMacroTranslations are ok? IMO the translation file should be in the same space as the macro. Thanks, Caty On Mon, Feb 23, 2015 at 6:59 PM, Thomas Mortagne <[email protected]> wrote:
Yes the translation should be part of the extension itself. Also don't forget to a new translation resource to http://l10.xwiki.org and the release script.
On Mon, Feb 23, 2015 at 4:44 PM, [email protected] <[email protected]> wrote:
On 23 Feb 2015 at 16:42:21, [email protected] ([email protected]
(mailto:[email protected])) wrote:
Hi Devs,
Even though we don’t have listed on
http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices I believe the following has already been agreed but I’d like to add it there so I’m sending it as a proposal.
So I propose that:
* Any java code requiring translation should put them in an
ApplicationResources.properties file at the root of the JAR (not the global ApplicationResources.properties in oldcore!)
* Any wiki page requiring translations should put them in a Translations page in the space for the app.
Special case: * For Macro UI modules (ie containing only wiki macros), we put them in the Macros space and in this case we should use a Macros.XXXTranslations page for each module. We’ll need to decide what we want to do in the future.
I meant that we’ll need to decide if we still consider that having this anonymous Macros space is a good thing or not, or if we should have for example dedicated spaces even in this case (with Macro translations, there should be no single page app for macros ;)).
Also, even if some existing module is wrongly using the ApplicationResources.properties in oldcore (for example), we should still follow the rules above and start doing it in the new way.
I meant: when we need to add new translations, we should still follow the rules above and start doing it in the new way.
Thanks -Vincent
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Hi Caty, On 24 Feb 2015 at 19:15:01, Ecaterina Moraru (Valica) ([email protected](mailto:[email protected])) wrote:
Hi,
Not all macros are in the Macros space. Actually this is quite a new thing and only a handful of macros follow this rule (although seems pretty decent).
For example MapMacro or PDFViewerMacro are located in the XWiki space. Where do I put the translations file? XWiki.MapMacroTranslations and XWiki.PDFViewerMacroTranslations are ok?
IMO the translation file should be in the same space as the macro.
What about the rest of the proposal? :) I think you’re only discussing about the special case of Macros that I mentioned for completeness. Yes, it makes sense to say that translation files for macros should be in the same space as the macro. Note that macros located in the XWiki space should be moved out, to the Macros space or inside their own app or existing apps. MapMacro and PDFViewerMacros should be moved to the Macros space probably (unless there are other pages in these XARs). As I mentioned we’ll need to officially decide if we want to keep the Macros space or do things differently. It wasn’t the purpose of this mail to decide on this though. Thanks -Vincent
Thanks, Caty
On Mon, Feb 23, 2015 at 6:59 PM, Thomas Mortagne wrote:
Yes the translation should be part of the extension itself. Also don't forget to a new translation resource to http://l10.xwiki.org and the release script.
On Mon, Feb 23, 2015 at 4:44 PM, [email protected] wrote:
On 23 Feb 2015 at 16:42:21, [email protected] ([email protected]
(mailto:[email protected])) wrote:
Hi Devs,
Even though we don’t have listed on
http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices I believe the following has already been agreed but I’d like to add it there so I’m sending it as a proposal.
So I propose that:
* Any java code requiring translation should put them in an
ApplicationResources.properties file at the root of the JAR (not the global ApplicationResources.properties in oldcore!)
* Any wiki page requiring translations should put them in a Translations page in the space for the app.
Special case: * For Macro UI modules (ie containing only wiki macros), we put them in the Macros space and in this case we should use a Macros.XXXTranslations page for each module. We’ll need to decide what we want to do in the future.
I meant that we’ll need to decide if we still consider that having this anonymous Macros space is a good thing or not, or if we should have for example dedicated spaces even in this case (with Macro translations, there should be no single page app for macros ;)).
Also, even if some existing module is wrongly using the ApplicationResources.properties in oldcore (for example), we should still follow the rules above and start doing it in the new way.
I meant: when we need to add new translations, we should still follow the rules above and start doing it in the new way.
Thanks -Vincent
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
+1 Thanks, Eduard On Tue, Feb 24, 2015 at 8:26 PM, [email protected] <[email protected]> wrote:
Hi Caty,
On 24 Feb 2015 at 19:15:01, Ecaterina Moraru (Valica) ([email protected] (mailto:[email protected])) wrote:
Hi,
Not all macros are in the Macros space. Actually this is quite a new thing and only a handful of macros follow this rule (although seems pretty decent).
For example MapMacro or PDFViewerMacro are located in the XWiki space. Where do I put the translations file? XWiki.MapMacroTranslations and XWiki.PDFViewerMacroTranslations are ok?
IMO the translation file should be in the same space as the macro.
What about the rest of the proposal? :)
I think you’re only discussing about the special case of Macros that I mentioned for completeness.
Yes, it makes sense to say that translation files for macros should be in the same space as the macro.
Note that macros located in the XWiki space should be moved out, to the Macros space or inside their own app or existing apps. MapMacro and PDFViewerMacros should be moved to the Macros space probably (unless there are other pages in these XARs).
As I mentioned we’ll need to officially decide if we want to keep the Macros space or do things differently. It wasn’t the purpose of this mail to decide on this though.
Thanks -Vincent
Thanks, Caty
On Mon, Feb 23, 2015 at 6:59 PM, Thomas Mortagne wrote:
Yes the translation should be part of the extension itself. Also don't forget to a new translation resource to http://l10.xwiki.org and the release script.
On Mon, Feb 23, 2015 at 4:44 PM, [email protected] wrote:
On 23 Feb 2015 at 16:42:21, [email protected] ([email protected]
(mailto:[email protected])) wrote:
Hi Devs,
Even though we don’t have listed on
http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices I believe the following has already been agreed but I’d like to add it there so I’m sending it as a proposal.
So I propose that:
* Any java code requiring translation should put them in an
ApplicationResources.properties file at the root of the JAR (not the global ApplicationResources.properties in oldcore!)
* Any wiki page requiring translations should put them in a Translations page in the space for the app.
Special case: * For Macro UI modules (ie containing only wiki macros), we put them in the Macros space and in this case we should use a Macros.XXXTranslations page for each module. We’ll need to decide what we want to do in the future.
I meant that we’ll need to decide if we still consider that having this anonymous Macros space is a good thing or not, or if we should have for example dedicated spaces even in this case (with Macro translations, there should be no single page app for macros ;)).
Also, even if some existing module is wrongly using the ApplicationResources.properties in oldcore (for example), we should still follow the rules above and start doing it in the new way.
I meant: when we need to add new translations, we should still follow the rules above and start doing it in the new way.
Thanks -Vincent
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
+1 Thanks, Caty On Wed, Feb 25, 2015 at 1:28 AM, Eduard Moraru <[email protected]> wrote:
+1
Thanks, Eduard
On Tue, Feb 24, 2015 at 8:26 PM, [email protected] <[email protected]> wrote:
Hi Caty,
On 24 Feb 2015 at 19:15:01, Ecaterina Moraru (Valica) ([email protected] (mailto:[email protected])) wrote:
Hi,
Not all macros are in the Macros space. Actually this is quite a new thing and only a handful of macros follow this rule (although seems pretty decent).
For example MapMacro or PDFViewerMacro are located in the XWiki space. Where do I put the translations file? XWiki.MapMacroTranslations and XWiki.PDFViewerMacroTranslations are ok?
IMO the translation file should be in the same space as the macro.
What about the rest of the proposal? :)
I think you’re only discussing about the special case of Macros that I mentioned for completeness.
Yes, it makes sense to say that translation files for macros should be in the same space as the macro.
Note that macros located in the XWiki space should be moved out, to the Macros space or inside their own app or existing apps. MapMacro and PDFViewerMacros should be moved to the Macros space probably (unless there are other pages in these XARs).
As I mentioned we’ll need to officially decide if we want to keep the Macros space or do things differently. It wasn’t the purpose of this mail to decide on this though.
Thanks -Vincent
Thanks, Caty
On Mon, Feb 23, 2015 at 6:59 PM, Thomas Mortagne wrote:
Yes the translation should be part of the extension itself. Also don't forget to a new translation resource to http://l10.xwiki.org and the release script.
On Mon, Feb 23, 2015 at 4:44 PM, [email protected] wrote:
On 23 Feb 2015 at 16:42:21, [email protected] ([email protected]
(mailto:[email protected])) wrote:
Hi Devs,
Even though we don’t have listed on
http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices I believe the following has already been agreed but I’d like to add it there so I’m sending it as a proposal.
So I propose that:
* Any java code requiring translation should put them in an
ApplicationResources.properties file at the root of the JAR (not the global ApplicationResources.properties in oldcore!)
* Any wiki page requiring translations should put them in a Translations page in the space for the app.
Special case: * For Macro UI modules (ie containing only wiki macros), we put them in the Macros space and in this case we should use a Macros.XXXTranslations page for each module. We’ll need to decide what we want to do in the future.
I meant that we’ll need to decide if we still consider that having this anonymous Macros space is a good thing or not, or if we should have for example dedicated spaces even in this case (with Macro translations, there should be no single page app for macros ;)).
Also, even if some existing module is wrongly using the ApplicationResources.properties in oldcore (for example), we should still follow the rules above and start doing it in the new way.
I meant: when we need to add new translations, we should still follow the rules above and start doing it in the new way.
Thanks -Vincent
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
+1 2015-02-25 9:52 GMT+01:00 Ecaterina Moraru (Valica) <[email protected]>:
+1
Thanks, Caty
On Wed, Feb 25, 2015 at 1:28 AM, Eduard Moraru <[email protected]> wrote:
+1
Thanks, Eduard
On Tue, Feb 24, 2015 at 8:26 PM, [email protected] <[email protected]> wrote:
Hi Caty,
On 24 Feb 2015 at 19:15:01, Ecaterina Moraru (Valica) ( [email protected] (mailto:[email protected])) wrote:
Hi,
Not all macros are in the Macros space. Actually this is quite a new thing and only a handful of macros follow this rule (although seems pretty decent).
For example MapMacro or PDFViewerMacro are located in the XWiki space. Where do I put the translations file? XWiki.MapMacroTranslations and XWiki.PDFViewerMacroTranslations are ok?
IMO the translation file should be in the same space as the macro.
What about the rest of the proposal? :)
I think you’re only discussing about the special case of Macros that I mentioned for completeness.
Yes, it makes sense to say that translation files for macros should be in the same space as the macro.
Note that macros located in the XWiki space should be moved out, to the Macros space or inside their own app or existing apps. MapMacro and PDFViewerMacros should be moved to the Macros space probably (unless there are other pages in these XARs).
As I mentioned we’ll need to officially decide if we want to keep the Macros space or do things differently. It wasn’t the purpose of this mail to decide on this though.
Thanks -Vincent
Thanks, Caty
On Mon, Feb 23, 2015 at 6:59 PM, Thomas Mortagne wrote:
Yes the translation should be part of the extension itself. Also don't forget to a new translation resource to http://l10.xwiki.org and the release script.
On Mon, Feb 23, 2015 at 4:44 PM, [email protected] wrote:
On 23 Feb 2015 at 16:42:21, [email protected] (
[email protected] (mailto:[email protected])) wrote:
> Hi Devs, > > Even though we don’t have listed on
http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices I believe the following has already been agreed but I’d like to add it there so I’m sending it as a proposal.
> > So I propose that: > > * Any java code requiring translation should put them in an ApplicationResources.properties file at the root of the JAR (not the global ApplicationResources.properties in oldcore!) > * Any wiki page requiring translations should put them in a Translations page in the space for the app. > > Special case: > * For Macro UI modules (ie containing only wiki macros), we put them in the Macros space and in this case we should use a Macros.XXXTranslations page for each module. We’ll need to decide what we want to do in the future.
I meant that we’ll need to decide if we still consider that having this anonymous Macros space is a good thing or not, or if we should have for example dedicated spaces even in this case (with Macro translations, there should be no single page app for macros ;)).
> Also, even if some existing module is wrongly using the ApplicationResources.properties in oldcore (for example), we should still follow the rules above and start doing it in the new way.
I meant: when we need to add new translations, we should still follow the rules above and start doing it in the new way.
Thanks -Vincent
> > WDYT? > > Thanks > -Vincent > > > > > _______________________________________________ > devs mailing list > [email protected] > http://lists.xwiki.org/mailman/listinfo/devs _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
Documentation has been updated at http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices#HTranslat... Thanks -Vincent On 23 Feb 2015 at 16:42:13, [email protected] ([email protected](mailto:[email protected])) wrote:
Hi Devs,
Even though we don’t have listed on http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices I believe the following has already been agreed but I’d like to add it there so I’m sending it as a proposal.
So I propose that:
* Any java code requiring translation should put them in an ApplicationResources.properties file at the root of the JAR (not the global ApplicationResources.properties in oldcore!) * Any wiki page requiring translations should put them in a Translations page in the space for the app.
Special case: * For Macro UI modules (ie containing only wiki macros), we put them in the Macros space and in this case we should use a Macros.XXXTranslations page for each module. We’ll need to decide what we want to do in the future.
Also, even if some existing module is wrongly using the ApplicationResources.properties in oldcore (for example), we should still follow the rules above and start doing it in the new way.
WDYT?
Thanks -Vincent
participants (5)
-
Ecaterina Moraru (Valica) -
Eduard Moraru -
Guillaume "Louis-Marie" Delhumeau -
Thomas Mortagne -
vincent＠massol.net