[
https://issues.apache.org/jira/browse/OFBIZ-3743?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-3743:
-----------------------------------
Hi Chris,
I think we should just discuss how you envision to answer to Adrian's concern about diverging helps. Let me explain how I see it so far.
1. For the moment we use *EntityLabels.xml files as you did so far to store the information
2. At some point in the future we wil extract and enhance this information and put in the help system (docBook)
3. We will then have a part of this information used for tooltips. A length of 150 chars max seems reasonnable
4. We will also create a javascript mechanism allowing to get the complete information from the help system by clicking in the tooltip if needed.
5. A third level of hep information, the help system itself, will give more structured information if necessary
Is that right?
Thanks
Jacques
____________________________________________________________________________________________________________
Hi Jacques,
I will need to spend some time looking at how the help system works to
be able to answer fully. However, from an end users perspective, I see
the help system as providing workflow type help that drills down to
field level help. This is similar to the compiere/adempiere help.
Therefore, the field descriptions would be used also in the help system.
What do you think?
Cheers,
Chris
____________________________________________________________________________________________________________
Yes that sounds good to me. Though, as I don't know how Compiere/Adempiere help works, I'm not quite sure to understand what "help system as providing workflow type help that drills down to
field level help." means exactly, could you elaborate, please?
Thanks
Jacques
____________________________________________________________________________________________________________
Hi Jacques - that is correct. I will change my focus back to the
overall help system integration.
I was hoping that by getting some tooltip examples in place (e.g.
ProductStore and ProductCatalog), I could maybe enroll some help from
other ofbiz users to extract the help from the "Manager X Reference"
guides. The next demo server refresh will pick up the ProductStore
field descriptions so I can use that as an example, and I will post a
message to the user forum asking for help...
As per adempiere screenshot. The top part of the help contains the overall description (e.g. workflow). Below this is the list of related entities and fields. This entity/field list is hyperlinks allowing you to drilldown to the actual field help descriptions.
Drilldown is probably not a good choice of word. I hope the above description and screenshot helps clarify my intentions. I now have to workout how to do this in the ofbiz help system.
Cheers,
Chris
____________________________________________________________________________________________________________
I'm not quite sure we should restrain the tooltip length. It seems that in modern browsers there are naly longer issues with that and with wider screens it not an issue as well.
I better understand the Compiere help and you intention now, thanks
Jacques
____________________________________________________________________________________________________________
> missing field description help
> ------------------------------
>
> Key: OFBIZ-3743
> URL:
https://issues.apache.org/jira/browse/OFBIZ-3743> Project: OFBiz
> Issue Type: Bug
> Components: ALL COMPONENTS
> Affects Versions: Release Branch 10.04, SVN trunk
> Reporter: chris snow
> Priority: Minor
>
> This issue has been setup for patches to improve documentation.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
Locked
