[jira] Created: (OFBIZ-3749) Field description tooltips show key if help text is not found

[Nicolas Malin (Jira)]

Field description tooltips show key if help text is not found
-------------------------------------------------------------

                 Key: OFBIZ-3749
                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
             Project: OFBiz
          Issue Type: Bug
          Components: ALL APPLICATIONS
    Affects Versions: Release Branch 10.04, SVN trunk
            Reporter: chris snow
             Fix For: Release Branch 10.04, SVN trunk


Tooltip currently shows field help message key if no help text has been provided.  For details, see:

http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

--
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-3749?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

chris snow updated OFBIZ-3749:
------------------------------

    Attachment: UtilHelpText.patch

> Field description tooltips show key if help text is not found
> -------------------------------------------------------------
>
>                 Key: OFBIZ-3749
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>             Project: OFBiz
>          Issue Type: Bug
>          Components: ALL APPLICATIONS
>    Affects Versions: Release Branch 10.04, SVN trunk
>            Reporter: chris snow
>             Fix For: Release Branch 10.04, SVN trunk
>
>         Attachments: UtilHelpText.patch
>
>
> Tooltip currently shows field help message key if no help text has been provided.  For details, see:
> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

--
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-3749?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Erwan de FERRIERES reassigned OFBIZ-3749:
-----------------------------------------

    Assignee: Erwan de FERRIERES

> Field description tooltips show key if help text is not found
> -------------------------------------------------------------
>
>                 Key: OFBIZ-3749
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>             Project: OFBiz
>          Issue Type: Bug
>          Components: ALL APPLICATIONS
>    Affects Versions: Release Branch 10.04, SVN trunk
>            Reporter: chris snow
>            Assignee: Erwan de FERRIERES
>             Fix For: Release Branch 10.04, SVN trunk
>
>         Attachments: UtilHelpText.patch
>
>
> Tooltip currently shows field help message key if no help text has been provided.  For details, see:
> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

--
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-3749?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12864230#action_12864230 ]

Erwan de FERRIERES commented on OFBIZ-3749:
-------------------------------------------

Hi Chris,

patch looks fine, but I think it would be better if the message was internationalized. Could you please improve it ?

Thanks,

> Field description tooltips show key if help text is not found
> -------------------------------------------------------------
>
>                 Key: OFBIZ-3749
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>             Project: OFBiz
>          Issue Type: Bug
>          Components: ALL APPLICATIONS
>    Affects Versions: Release Branch 10.04, SVN trunk
>            Reporter: chris snow
>            Assignee: Erwan de FERRIERES
>             Fix For: Release Branch 10.04, SVN trunk
>
>         Attachments: UtilHelpText.patch
>
>
> Tooltip currently shows field help message key if no help text has been provided.  For details, see:
> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

--
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-3749?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12864232#action_12864232 ]

chris snow commented on OFBIZ-3749:
-----------------------------------

Hi Erwan,

Internationalize which message?  The tooltips are internationalized.  Are you talking about the log message?:

Debug.logInfo("No help text found in [" + entityResourceName + "] with key [" + messageId + "]", module);

Many thanks,

Chris

> Field description tooltips show key if help text is not found
> -------------------------------------------------------------
>
>                 Key: OFBIZ-3749
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>             Project: OFBiz
>          Issue Type: Bug
>          Components: ALL APPLICATIONS
>    Affects Versions: Release Branch 10.04, SVN trunk
>            Reporter: chris snow
>            Assignee: Erwan de FERRIERES
>             Fix For: Release Branch 10.04, SVN trunk
>
>         Attachments: UtilHelpText.patch
>
>
> Tooltip currently shows field help message key if no help text has been provided.  For details, see:
> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

--
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-3749?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12864236#action_12864236 ]

Erwan de FERRIERES commented on OFBIZ-3749:
-------------------------------------------

Sorry Chris,
I was a bit too quick on reading the patch.... Please forget what I said before !
Will commit today !

> Field description tooltips show key if help text is not found
> -------------------------------------------------------------
>
>                 Key: OFBIZ-3749
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>             Project: OFBiz
>          Issue Type: Bug
>          Components: ALL APPLICATIONS
>    Affects Versions: Release Branch 10.04, SVN trunk
>            Reporter: chris snow
>            Assignee: Erwan de FERRIERES
>             Fix For: Release Branch 10.04, SVN trunk
>
>         Attachments: UtilHelpText.patch
>
>
> Tooltip currently shows field help message key if no help text has been provided.  For details, see:
> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

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

[Chris Snow-3]

Many thanks!

Related to this patch, is: https://issues.apache.org/jira/browse/OFBIZ-3747

The related patch contains the actual help messages for the ProductStore
UI page.  It would be nice if that patch got committed too! ;)

>
>     [
> https://issues.apache.org/jira/browse/OFBIZ-3749?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12864236#action_12864236
> ]
>
> Erwan de FERRIERES commented on OFBIZ-3749:
> -------------------------------------------
>
> Sorry Chris,
> I was a bit too quick on reading the patch.... Please forget what I said
> before !
> Will commit today !
>
>> Field description tooltips show key if help text is not found
>> -------------------------------------------------------------
>>
>>                 Key: OFBIZ-3749
>>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>>             Project: OFBiz
>>          Issue Type: Bug
>>          Components: ALL APPLICATIONS
>>    Affects Versions: Release Branch 10.04, SVN trunk
>>            Reporter: chris snow
>>            Assignee: Erwan de FERRIERES
>>             Fix For: Release Branch 10.04, SVN trunk
>>
>>         Attachments: UtilHelpText.patch
>>
>>
>> Tooltip currently shows field help message key if no help text has been
>> provided.  For details, see:
>> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html
>
> --
> This message is automatically generated by JIRA.
> -
> You can reply to this email to add a comment to the issue online.
>
>

--
Chris Snow - CEng MBCS CITP MBA (Tech Mgmt) (Open) CISSP

Tel: [phone]
Mob: [phone]
Www: www.snowconsulting.co.uk

[Nicolas Malin (Jira)]

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

Erwan de FERRIERES closed OFBIZ-3749.
-------------------------------------

    Resolution: Fixed

Thanks Chris, done in trunk at 941261 and in 10.04 at 941262

I just modified your patch to add a test if logInfo is active.

> Field description tooltips show key if help text is not found
> -------------------------------------------------------------
>
>                 Key: OFBIZ-3749
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>             Project: OFBiz
>          Issue Type: Bug
>          Components: ALL APPLICATIONS
>    Affects Versions: Release Branch 10.04, SVN trunk
>            Reporter: chris snow
>            Assignee: Erwan de FERRIERES
>             Fix For: Release Branch 10.04, SVN trunk
>
>         Attachments: UtilHelpText.patch
>
>
> Tooltip currently shows field help message key if no help text has been provided.  For details, see:
> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

--
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-3749?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12864307#action_12864307 ]

chris snow commented on OFBIZ-3749:
-----------------------------------

Hi Erwan,

Sorry to be a pain, but the change with the Debug.infoOn() check is broken, it should be:

{code}
// return an empty field help description if there is no value found for the key
if (fieldDescription.equals(messageId)) {
    if (Debug.infoOn()) {
        Debug.logInfo("No help text found in [" + entityResourceName + "] with key [" + messageId + "]", module);
    }
    return "";
}
{code}

I.e. we need to return an empty string if there is no value found for the key, regardless of whether debuging is on or off.

Cheers,

Chris

> Field description tooltips show key if help text is not found
> -------------------------------------------------------------
>
>                 Key: OFBIZ-3749
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>             Project: OFBiz
>          Issue Type: Bug
>          Components: ALL APPLICATIONS
>    Affects Versions: Release Branch 10.04, SVN trunk
>            Reporter: chris snow
>            Assignee: Erwan de FERRIERES
>             Fix For: Release Branch 10.04, SVN trunk
>
>         Attachments: UtilHelpText.patch
>
>
> Tooltip currently shows field help message key if no help text has been provided.  For details, see:
> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

--
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-3749?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

chris snow reopened OFBIZ-3749:
-------------------------------


see previous comment

> Field description tooltips show key if help text is not found
> -------------------------------------------------------------
>
>                 Key: OFBIZ-3749
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>             Project: OFBiz
>          Issue Type: Bug
>          Components: ALL APPLICATIONS
>    Affects Versions: Release Branch 10.04, SVN trunk
>            Reporter: chris snow
>            Assignee: Erwan de FERRIERES
>             Fix For: Release Branch 10.04, SVN trunk
>
>         Attachments: UtilHelpText.patch
>
>
> Tooltip currently shows field help message key if no help text has been provided.  For details, see:
> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

--
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-3749?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Erwan de FERRIERES closed OFBIZ-3749.
-------------------------------------

    Resolution: Fixed

Done at 941600 and 941603

Thanks Chris,

> Field description tooltips show key if help text is not found
> -------------------------------------------------------------
>
>                 Key: OFBIZ-3749
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>             Project: OFBiz
>          Issue Type: Bug
>          Components: ALL APPLICATIONS
>    Affects Versions: Release Branch 10.04, SVN trunk
>            Reporter: chris snow
>            Assignee: Erwan de FERRIERES
>             Fix For: Release Branch 10.04, SVN trunk
>
>         Attachments: UtilHelpText.patch
>
>
> Tooltip currently shows field help message key if no help text has been provided.  For details, see:
> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

--
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-3749?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12864845#action_12864845 ]

Bob Morley commented on OFBIZ-3749:
-----------------------------------

Two quick questions ...

1) Since Debug.logInfo ultimately determines if logging for "info" is on, isn't it better to just call Debug.logInfo directly (paying the string construction penalty of course) ?

2) While it is pretty unlikely that the help key here would be defined in the resource bundle with the same value; this code would turn those into empty string.  Would it be better to overload getMessage to allow an optional default message ... so we could do ...

    String fieldDescription = UtilProperties.getMessage(entityResourceName, messageId, locale, null);
    if (fieldDescription == null) {
        ...

> Field description tooltips show key if help text is not found
> -------------------------------------------------------------
>
>                 Key: OFBIZ-3749
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>             Project: OFBiz
>          Issue Type: Bug
>          Components: ALL APPLICATIONS
>    Affects Versions: Release Branch 10.04, SVN trunk
>            Reporter: chris snow
>            Assignee: Erwan de FERRIERES
>             Fix For: Release Branch 10.04, SVN trunk
>
>         Attachments: UtilHelpText.patch
>
>
> Tooltip currently shows field help message key if no help text has been provided.  For details, see:
> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

--
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-3749?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12864893#action_12864893 ]

chris snow commented on OFBIZ-3749:
-----------------------------------

Hi Bob,  I agree with you on both points...

> Field description tooltips show key if help text is not found
> -------------------------------------------------------------
>
>                 Key: OFBIZ-3749
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-3749
>             Project: OFBiz
>          Issue Type: Bug
>          Components: ALL APPLICATIONS
>    Affects Versions: Release Branch 10.04, SVN trunk
>            Reporter: chris snow
>            Assignee: Erwan de FERRIERES
>             Fix For: Release Branch 10.04, SVN trunk
>
>         Attachments: UtilHelpText.patch
>
>
> Tooltip currently shows field help message key if no help text has been provided.  For details, see:
> http://ofbiz.135035.n4.nabble.com/New-branch-is-now-available-for-upcoming-releases-of-10-04-series-tp2111929p2122465.html

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