[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12602665#action_12602665
]
Adrian Crum commented on OFBIZ-1750:
------------------------------------
Bruno,
I think the system will work as committed. You are right, the help system at
this moment is simple. It can be expanded and improved. One of the common
design patterns in OFBiz is to have something low level like this that all
components share, then each component builds upon it or improves it.
For example, a component could override the common (shared) help request and
implement its own sophisticated help system.
There is nothing in the current implementation that would prevent a component
from pointing its Help links to a public site, so I still don't see the need
for a "isUrl" flag.
> Online user help link icon
> --------------------------
>
> Key: OFBIZ-1750
> URL: https://issues.apache.org/jira/browse/OFBIZ-1750
> Project: OFBiz
> Issue Type: New Feature
> Components: ALL COMPONENTS
> Affects Versions: SVN trunk
> Reporter: Bruno Busco
> Assignee: Adrian Crum
> Priority: Minor
> Attachments: help_links.jpg, help_links.patch, help_links1.patch,
> help_links2.patch, help_yellow.gif
>
>
> I have implemented an on-line help linking system the you can find in the
> attached patch (help_links.patch) and preview in help_links.jpg.
> This is a short description of how it works.
> I have added a "link-url" property to the container tag. Now it is possible
> to write something like:
> <property-map resource="ProjectMgrUiHelpUrls" map-name="uiHelpUrlsMap"
> global="true"/>
> ...
> <container style="screenlet"
> help-url="${uiHelpUrlsMap.ProjectManagerApplicationRoles}">
> When such a property is specified the container is rendered with a textual
> "?" that contains an href to an help page url.
> I have included in the patch also a modified maincss.css file that shows a
> more beatifull yellow icon like you can see in the preview.
> I have done some thinking about how to build the help urls with the following
> requirements:
> 1) Should be possible to change the whole help site used with a single
> modification in one file
> 2) Different help urls should be used depending on th locale
> To implement this I added the HelpUrls.xml resource file that in in the
> framework and defines the following keys:
> - helpurls.prefix = the first part of every help url
> - helpurls.suffix = the last part of every help url
> - helpurls.hint = a string that is displayed when the mouse is moved on the
> help icon
> All these keys are translated in urls and strings that are (or can be)
> specific to the selected locale. I this way it is possible for example to
> have the different languages help pages located on different sites (changing
> the helpurl.prefix) or it is possible to have an help system that provides
> different language help based on parameter attached to the url (something
> like ?language=it or similar)
> The final url attached to the icon is made of the prefix, the container
> specific help-url and the suffix
> Even the container specific help-url could conveniently be taken from a
> resource file so that a change in the help system pages should require only
> the resource file modification and not all the screens.
> I have included in the patch a single modified screen that uses the help
> links. This is one of the Project Manager Application that is available at
> this link:
> https://localhost:8443/projectmgr/control/MyTasks
> Could you please review the system?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
