[jira] Created: (OFBIZ-3807) Application name localizations should not be defined in the CommonUiLabels framework file

[Nicolas Malin (Jira)]

Application name localizations should not be defined in the CommonUiLabels framework file
-----------------------------------------------------------------------------------------

                 Key: OFBIZ-3807
                 URL: https://issues.apache.org/jira/browse/OFBIZ-3807
             Project: OFBiz
          Issue Type: Improvement
          Components: ALL COMPONENTS
    Affects Versions: SVN trunk
            Reporter: Bruno Busco
            Priority: Minor


There is a weak dependence of the framework from ALL applications because the application name localization for the application menu is defined in CommonUiLabels.xml file.
Whenever a user wants to add an application and localize its name, a new entry in CommonUiLabels.xml framework file needs to be created.
How could we have the application menu use the application specific labels file to get the localitazion?
The injectable menu we are speaking about could be the solution.
A simple main menu could be defined in the framework with only the Webtools and Example menu entries.

Every application could inject its own application menu entries.
An application could also inject menu entries in several different menus so that, for example all application's administrations could be placed in one unique high level "admin" menu entry.

This could also allow a party/content binding component to inject menu entries into otherwise stand-alone party and content applications.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

[Nicolas Malin (Jira)]

     [ https://issues.apache.org/jira/browse/OFBIZ-3807?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Adrian Crum updated OFBIZ-3807:
-------------------------------

    Description:
There is a weak dependence from the framework to ALL applications because the application name localization for the application menu is defined in CommonUiLabels.xml file.
Whenever a user wants to add an application and localize its name, a new entry in CommonUiLabels.xml framework file needs to be created.
How could we have the application menu use the application specific labels file to get the localitazion?
The injectable menu we are speaking about could be the solution.
A simple main menu could be defined in the framework with only the Webtools and Example menu entries.

Every application could inject its own application menu entries.
An application could also inject menu entries in several different menus so that, for example all application's administrations could be placed in one unique high level "admin" menu entry.

This could also allow a party/content binding component to inject menu entries into otherwise stand-alone party and content applications.

  was:
There is a weak dependence of the framework from ALL applications because the application name localization for the application menu is defined in CommonUiLabels.xml file.
Whenever a user wants to add an application and localize its name, a new entry in CommonUiLabels.xml framework file needs to be created.
How could we have the application menu use the application specific labels file to get the localitazion?
The injectable menu we are speaking about could be the solution.
A simple main menu could be defined in the framework with only the Webtools and Example menu entries.

Every application could inject its own application menu entries.
An application could also inject menu entries in several different menus so that, for example all application's administrations could be placed in one unique high level "admin" menu entry.

This could also allow a party/content binding component to inject menu entries into otherwise stand-alone party and content applications.

> Application name localizations should not be defined in the CommonUiLabels framework file
> -----------------------------------------------------------------------------------------
>
>                 Key: OFBIZ-3807
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3807
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: SVN trunk
>            Reporter: Bruno Busco
>            Priority: Minor
>
> There is a weak dependence from the framework to ALL applications because the application name localization for the application menu is defined in CommonUiLabels.xml file.
> Whenever a user wants to add an application and localize its name, a new entry in CommonUiLabels.xml framework file needs to be created.
> How could we have the application menu use the application specific labels file to get the localitazion?
> The injectable menu we are speaking about could be the solution.
> A simple main menu could be defined in the framework with only the Webtools and Example menu entries.
> Every application could inject its own application menu entries.
> An application could also inject menu entries in several different menus so that, for example all application's administrations could be placed in one unique high level "admin" menu entry.
> This could also allow a party/content binding component to inject menu entries into otherwise stand-alone party and content applications.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

[Nicolas Malin (Jira)]

    [ https://issues.apache.org/jira/browse/OFBIZ-3807?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12875765#action_12875765 ]

Adrian Crum commented on OFBIZ-3807:
------------------------------------

From my perspective, the application menu dependency problem can be reduced down to one simple requirement: We need a way to specify a property file in addition to a property name. There are several approaches I can think of (other commenters can add more):

1. Add "title-property" and "title-property-location" attributes to the ofbiz-component.xml file webapp element.
2. Add a property protocol to the framework (property://SomFile.xml#SomeProperty) and use that in  a "title-property" attribute in the ofbiz-component.xml file webapp element.
3. Add a property file handler to the component: protocol (component://application/config/SomFile.xml#SomeProperty) and use that in  a "title-property" attribute in the ofbiz-component.xml file webapp element.

I don't know how an "injectable menu" works, so I can't comment on that. Maybe we need a separate Jira issue to discuss injectable menus.

> Application name localizations should not be defined in the CommonUiLabels framework file
> -----------------------------------------------------------------------------------------
>
>                 Key: OFBIZ-3807
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3807
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: SVN trunk
>            Reporter: Bruno Busco
>            Priority: Minor
>
> There is a weak dependence from the framework to ALL applications because the application name localization for the application menu is defined in CommonUiLabels.xml file.
> Whenever a user wants to add an application and localize its name, a new entry in CommonUiLabels.xml framework file needs to be created.
> How could we have the application menu use the application specific labels file to get the localitazion?
> The injectable menu we are speaking about could be the solution.
> A simple main menu could be defined in the framework with only the Webtools and Example menu entries.
> Every application could inject its own application menu entries.
> An application could also inject menu entries in several different menus so that, for example all application's administrations could be placed in one unique high level "admin" menu entry.
> This could also allow a party/content binding component to inject menu entries into otherwise stand-alone party and content applications.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

[Nicolas Malin (Jira)]

    [ https://issues.apache.org/jira/browse/OFBIZ-3807?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12875826#action_12875826 ]

Scott Gray commented on OFBIZ-3807:
-----------------------------------

I have a nowhere near commit quality patch for controller and menu injection that I'll try and upload this weekend.  It all works just fine but the code isn't great, just the results of a fairly quick hack session.

I won't have time to work on it again in the immediate future so my hope is that the community will realize the potential of these features and continue the work I've started.

> Application name localizations should not be defined in the CommonUiLabels framework file
> -----------------------------------------------------------------------------------------
>
>                 Key: OFBIZ-3807
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3807
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: SVN trunk
>            Reporter: Bruno Busco
>            Priority: Minor
>
> There is a weak dependence from the framework to ALL applications because the application name localization for the application menu is defined in CommonUiLabels.xml file.
> Whenever a user wants to add an application and localize its name, a new entry in CommonUiLabels.xml framework file needs to be created.
> How could we have the application menu use the application specific labels file to get the localitazion?
> The injectable menu we are speaking about could be the solution.
> A simple main menu could be defined in the framework with only the Webtools and Example menu entries.
> Every application could inject its own application menu entries.
> An application could also inject menu entries in several different menus so that, for example all application's administrations could be placed in one unique high level "admin" menu entry.
> This could also allow a party/content binding component to inject menu entries into otherwise stand-alone party and content applications.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

[Nicolas Malin (Jira)]

    [ https://issues.apache.org/jira/browse/OFBIZ-3807?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12875843#action_12875843 ]

Adrian Crum commented on OFBIZ-3807:
------------------------------------

Scott,

That would be cool.. If you wouldn't mind, please create a new Jira issue for it so we can discuss it separately from the dependency issue being discussed here. I'm sure the patch you have will be fine, and there seems to be a lot of interest in it.

> Application name localizations should not be defined in the CommonUiLabels framework file
> -----------------------------------------------------------------------------------------
>
>                 Key: OFBIZ-3807
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3807
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: SVN trunk
>            Reporter: Bruno Busco
>            Priority: Minor
>
> There is a weak dependence from the framework to ALL applications because the application name localization for the application menu is defined in CommonUiLabels.xml file.
> Whenever a user wants to add an application and localize its name, a new entry in CommonUiLabels.xml framework file needs to be created.
> How could we have the application menu use the application specific labels file to get the localitazion?
> The injectable menu we are speaking about could be the solution.
> A simple main menu could be defined in the framework with only the Webtools and Example menu entries.
> Every application could inject its own application menu entries.
> An application could also inject menu entries in several different menus so that, for example all application's administrations could be placed in one unique high level "admin" menu entry.
> This could also allow a party/content binding component to inject menu entries into otherwise stand-alone party and content applications.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

[Nicolas Malin (Jira)]

    [ https://issues.apache.org/jira/browse/OFBIZ-3807?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12875855#action_12875855 ]

Jacques Le Roux commented on OFBIZ-3807:
----------------------------------------

Yes I agree with Adrian, wee need that

Note that 2 related Jira already exist: OFBIZ-3233 OFBIZ-3766

Thanks Scott!

> Application name localizations should not be defined in the CommonUiLabels framework file
> -----------------------------------------------------------------------------------------
>
>                 Key: OFBIZ-3807
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3807
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: SVN trunk
>            Reporter: Bruno Busco
>            Priority: Minor
>
> There is a weak dependence from the framework to ALL applications because the application name localization for the application menu is defined in CommonUiLabels.xml file.
> Whenever a user wants to add an application and localize its name, a new entry in CommonUiLabels.xml framework file needs to be created.
> How could we have the application menu use the application specific labels file to get the localitazion?
> The injectable menu we are speaking about could be the solution.
> A simple main menu could be defined in the framework with only the Webtools and Example menu entries.
> Every application could inject its own application menu entries.
> An application could also inject menu entries in several different menus so that, for example all application's administrations could be placed in one unique high level "admin" menu entry.
> This could also allow a party/content binding component to inject menu entries into otherwise stand-alone party and content applications.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

[Nicolas Malin (Jira)]

    [ https://issues.apache.org/jira/browse/OFBIZ-3807?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12875873#action_12875873 ]

Bruno Busco commented on OFBIZ-3807:
------------------------------------

Many thanks for the feedbacks on this.
Having Scott's starting point for the injectable menus will be great.

About Adrian's proposal of improving the property protocol and related, I would better try to see if it could be possible to completely replace the actual application title with a complete injected application menu.

I mean:

Assumed that we have the injection menu, the framework would define the first level menu with the "Web Tools" and the "Example" entries. All other application wouuld inject their own menu.
The injected menu could be not just the "Application Title" entry but the complete TabBarMenu that is normally rendered when accessing the application main page.
This would allow to render a two levels application menu:
- Application 1
    - Entry 1.1
    - Entry 1.2
    - Entry 1.3
- Application 2
    - Entry 2.1
    - Entry 2.2
    - Entry 2.3

that would allow direct access to "second level" applications screens.

> Application name localizations should not be defined in the CommonUiLabels framework file
> -----------------------------------------------------------------------------------------
>
>                 Key: OFBIZ-3807
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3807
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: SVN trunk
>            Reporter: Bruno Busco
>            Priority: Minor
>
> There is a weak dependence from the framework to ALL applications because the application name localization for the application menu is defined in CommonUiLabels.xml file.
> Whenever a user wants to add an application and localize its name, a new entry in CommonUiLabels.xml framework file needs to be created.
> How could we have the application menu use the application specific labels file to get the localitazion?
> The injectable menu we are speaking about could be the solution.
> A simple main menu could be defined in the framework with only the Webtools and Example menu entries.
> Every application could inject its own application menu entries.
> An application could also inject menu entries in several different menus so that, for example all application's administrations could be placed in one unique high level "admin" menu entry.
> This could also allow a party/content binding component to inject menu entries into otherwise stand-alone party and content applications.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

[Nicolas Malin (Jira)]

    [ https://issues.apache.org/jira/browse/OFBIZ-3807?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12876002#action_12876002 ]

Scott Gray commented on OFBIZ-3807:
-----------------------------------

I've attached my patch to OFBIZ-3373

The patch would solve the problem described in this issue, although you'd have to have an action within each injected menu that loads the resource bundles necessary for the menu item labels.

> Application name localizations should not be defined in the CommonUiLabels framework file
> -----------------------------------------------------------------------------------------
>
>                 Key: OFBIZ-3807
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3807
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: SVN trunk
>            Reporter: Bruno Busco
>            Priority: Minor
>
> There is a weak dependence from the framework to ALL applications because the application name localization for the application menu is defined in CommonUiLabels.xml file.
> Whenever a user wants to add an application and localize its name, a new entry in CommonUiLabels.xml framework file needs to be created.
> How could we have the application menu use the application specific labels file to get the localitazion?
> The injectable menu we are speaking about could be the solution.
> A simple main menu could be defined in the framework with only the Webtools and Example menu entries.
> Every application could inject its own application menu entries.
> An application could also inject menu entries in several different menus so that, for example all application's administrations could be placed in one unique high level "admin" menu entry.
> This could also allow a party/content binding component to inject menu entries into otherwise stand-alone party and content applications.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

[Nicolas Malin (Jira)]

     [ https://issues.apache.org/jira/browse/OFBIZ-3807?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bruno Busco updated OFBIZ-3807:
-------------------------------

    Attachment: POC_InjectedMainMenu.patch

I started playing with the menu injection patch Scott has provided in OFBIZ-3373 to see how we could use this mechanism to allow all applications inject their main menu in a framework defined common MainMenu.

In the attached patch there is a very simple POC of this (you need to apply the https://issues.apache.org/jira/secure/attachment/12448859/injections.patch from OFBIZ-3373 to test it).

The Party and ProjectMgr applications inject their main menus in a framework defined MainMenu.
This new main menu is rendered directly under the header (just to see if it works).

- It seems we should be able to inject complete menus and not only menu items so that a two levels menu could be formed.
- Being able to inject a complete already defined menu would be IMO the best.
- It seems that the uiLabel handling still has some issue. The Party menu is well rendered while the Project not.

> Application name localizations should not be defined in the CommonUiLabels framework file
> -----------------------------------------------------------------------------------------
>
>                 Key: OFBIZ-3807
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3807
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: SVN trunk
>            Reporter: Bruno Busco
>            Priority: Minor
>         Attachments: POC_InjectedMainMenu.patch
>
>
> There is a weak dependence from the framework to ALL applications because the application name localization for the application menu is defined in CommonUiLabels.xml file.
> Whenever a user wants to add an application and localize its name, a new entry in CommonUiLabels.xml framework file needs to be created.
> How could we have the application menu use the application specific labels file to get the localitazion?
> The injectable menu we are speaking about could be the solution.
> A simple main menu could be defined in the framework with only the Webtools and Example menu entries.
> Every application could inject its own application menu entries.
> An application could also inject menu entries in several different menus so that, for example all application's administrations could be placed in one unique high level "admin" menu entry.
> This could also allow a party/content binding component to inject menu entries into otherwise stand-alone party and content applications.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.