OFBiz › OFBiz - Dev

[jira] Created: (OFBIZ-3702) provide better user help

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

41 messages Options

123

Nicolas Malin (Jira)

[jira] Created: (OFBIZ-3702) provide better user help

provide better user help
------------------------

Key: OFBIZ-3702
URL: https://issues.apache.org/jira/browse/OFBIZ-3702
Project: OFBiz
Issue Type: Improvement
Affects Versions: Release Candidate Branch 10.04, SVN trunk
Reporter: chris snow

Please see http://n4.nabble.com/Providing-users-with-help-td1840416.html

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

Nicolas Malin (Jira)

[jira] Updated: (OFBIZ-3702) provide better user help

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

chris snow updated OFBIZ-3702:
------------------------------

Attachment: product_entitymodel.patch

I've added some more inventory related descriptions to the ProductStore entity. I've also changed some of the descriptions for inventory to match the "Manager Reference".

I have only added the inventory descriptions because I'm not sure how this stuff will be reflected in the UI. I didn't want to add descriptions for everything to later find a lot of them had to be reworked.

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: product_entitymodel.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.html

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

chris snow commented on OFBIZ-3702:
-----------------------------------

Hi Hans, I'm not sure how I can access the entity field descriptions in forms. Can you please point me in the right direction?

Many thanks,

Chris

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

Hans Bakker commented on OFBIZ-3702:
------------------------------------

hi chris, you might want look how it is done in webtools -> entity reference there the descriptions are already shown.....it is using jsp there though.....

Hans

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

chris snow commented on OFBIZ-3702:
-----------------------------------

Thanks Hans!

Nicolas Malin (Jira)

[jira] Updated: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

chris snow updated OFBIZ-3702:
------------------------------

Attachment: tooltip_help_DO_NOT_COMMIT.patch

The attached patch "tooltip_help_DO_NOT_COMMIT.patch" is not intended to be commited.

Please take a look and give me some feedback. Notice that I have hijacked the tooltip method for this proof-of-concept. This would need to be done properly in the final solution. Also, the final solution would need to take care of i18n.

Apply the patch on trunk, install demo data and take a look at the URL:

https://localhost:8443/catalog/control/EditProductStore?productStoreId=9000

You should see some help icons next to the inventory fields:

- Is Immediately Fulfilled
- Balance Res On Order Creation

Note, the patch only tried with firefox.

Any feedback / comments anyone?

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.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)

[jira] Updated: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

Nicolas Malin (Jira)

[jira] Updated: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.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)

[jira] Updated: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.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)

[jira] Commented: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

Scott Gray commented on OFBIZ-3702:
-----------------------------------

You need to go back to multiple lines when building the macro call, string concatenation is avoided for a reason.

What would a user do if they wanted to remove or already this help field? Not criticizing, just putting it out there as a question.

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: entity_field_tooltip_screenshot.png, help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.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)

[jira] Updated: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

chris snow updated OFBIZ-3702:
------------------------------

Attachment: entity_field_tooltip_screenshot.png

Attached example screenshot showing tooltip generate from entity field description.

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: entity_field_tooltip_screenshot.png, help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.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)

[jira] Commented: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

chris snow commented on OFBIZ-3702:
-----------------------------------

Hi Scott, many thanks for the feedback.

I will use multiple lines for macro call .

Are you suggesting that we should consider giving the user the option to customize whether or not they can see the field help icon?

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: entity_field_tooltip_screenshot.png, help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.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)

[jira] Commented: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

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

From a tooltip content POV here is IMO [an interesting link|https://cwiki.apache.org/confluence/display/OFBADMIN/New+Features+Roadmap+-+Living+Document#NewFeaturesRoadmap-LivingDocument-Quickeranintuitiveaccesstobasicfunctionnalities]. The interesting part related to this issue begins at "For a first effort, it was suggested that tools tips that direct the user to the necessary steps would be sufficient"

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: entity_field_tooltip_screenshot.png, help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.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)

[jira] Commented: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

Bruno Busco commented on OFBIZ-3702:
------------------------------------

Could we think to have the tooltip help shown putting the mous on the field name instead of the new "?" icon?
Having a "?" for every field could get the page too much crowded and get the user confused.
Anyway I really like the idea of havig such help feature. Just lets think a way to have it less "invasive".

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: entity_field_tooltip_screenshot.png, help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.html

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

chris snow-2

Re: [jira] Commented: (OFBIZ-3702) provide better user help

On 20 Apr 2010 20:41, "Bruno Busco (JIRA)" <[hidden email]> wrote:

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

Bruno Busco commented on OFBIZ-3702:
------------------------------------

Could we think to have the tooltip help shown putting the mous on the field
name instead of the new "?" icon?
Having a "?" for every field could get the page too much crowded and get the
user confused.
Anyway I really like the idea of havig such help feature. Just lets think a
way to have it less "invasive".

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> ...

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

Scott Gray commented on OFBIZ-3702:
-----------------------------------

Hi Chris, sorry by user I meant developer-user rather than end user.

As far as I can tell there is no way for the developer to switch this off and the only way to change the text displayed is by modifying the entity definition.

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: entity_field_tooltip_screenshot.png, help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.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)

[jira] Commented: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

chris snow commented on OFBIZ-3702:
-----------------------------------

Hi Scott/Devs,

Instead of storing the text in the entity definition, what about storing the help in property files? For example we could have something like:

{code}
File: /applications/product/config/ProductEntityFieldHelpLabels.xml :

<property key="ENTITY_FIELD_HELP.ProductStore.balanceResOnOrderCreation">
<value xml:lang="en">If set to Y, when a new sales order is created with backordered items, then ...</value>
...
</property>
{code}

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: entity_field_tooltip_screenshot.png, help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.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)

[jira] Updated: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

chris snow updated OFBIZ-3702:
------------------------------

Attachment: fieldLabelTooltip_DO_NOT_COMMIT.patch
fieldLabelTooltip.png

The patch fieldLabelTooltip_DO_NOT_COMMIT.patch provides an alternative method of providing pop up field help using property files instead on entity field descriptions. This gives the help pop ups full i18n support.

The code is a hack and not intentended to be commited. The property files must follow the naming convention:

componentname__EntityFieldHelpLabels.xml

Any comments?

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: entity_field_tooltip_screenshot.png, fieldLabelTooltip.png, fieldLabelTooltip_DO_NOT_COMMIT.patch, help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.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)

[jira] Commented: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

chris snow commented on OFBIZ-3702:
-----------------------------------

i forgot to say ...

fieldLabelTooltip_DO_NOT_COMMIT.patch provides help by hovering over the field label as suggested by Bruno. See the attached screenshot: fieldLabelTooltip.png

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: entity_field_tooltip_screenshot.png, fieldLabelTooltip.png, fieldLabelTooltip_DO_NOT_COMMIT.patch, help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.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)

[jira] Commented: (OFBIZ-3702) provide better user help

In reply to this post by Nicolas Malin (Jira)

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

Adrian Crum commented on OFBIZ-3702:
------------------------------------

Chris,

Internationalization of entity field descriptions is already implemented. Look in framework/example/config/ExampleEntityLabels.xml for the FieldDescription.* properties.

> provide better user help
> ------------------------
>
> Key: OFBIZ-3702
> URL: https://issues.apache.org/jira/browse/OFBIZ-3702
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Release Candidate Branch 10.04, SVN trunk
> Reporter: chris snow
> Attachments: entity_field_tooltip_screenshot.png, fieldLabelTooltip.png, fieldLabelTooltip_DO_NOT_COMMIT.patch, help.png, product_entitymodel.patch, tooltip_help_DO_NOT_COMMIT.patch
>
>
> Please see http://n4.nabble.com/Providing-users-with-help-td1840416.html

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

123