[jira] Commented: (OFBIZ-1750) Online user help link icon
[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=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.
[jira] Commented: (OFBIZ-1750) Online user help link icon
[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=12602392#action_12602392
]
Adrian Crum commented on OFBIZ-1750:
Bruno,
Thank you for the updated patch - it looks much better. I will make a few
changes to it and get it committed.
To point a help link to an external site, you would only need to do something
like this:
help-url=http://help.ofbiz.org?topic=ProjectMgrHelpTopic3;
The help request in the project manager controller.xml isn't needed because it
is already included from common-controller.xml.
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.
[jira] Commented: (OFBIZ-1750) Online user help link icon
[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=12602405#action_12602405
]
Bruno Busco commented on OFBIZ-1750:
Adrian,
having the URL in the property let us have different web pages for different
locales.
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.
[jira] Commented: (OFBIZ-1750) Online user help link icon
[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=12602476#action_12602476
]
Adrian Crum commented on OFBIZ-1750:
Bruno,
I committed portions of your patch (with modifications) in rev 663378.
After I thought about it, I realized we already have the ability to create
links in various screen widgets - so we can just use those.
I didn't commit the gif file because it appears to be taken from the Jira
website and I'm not sure the Atlassian people would appreciate us stealing it.
Using the Confluence site for the help system is a good idea, but it won't work
for users who don't have an internet connection (like many of the users where I
work).
Anyway, this is a good start - let's see where it goes.
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.
[jira] Commented: (OFBIZ-1750) Online user help link icon
[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=12602547#action_12602547
]
Bruno Busco commented on OFBIZ-1750:
Adrian,
yes, for sure having it simpled down is a good start.
Anyway I think that having a simple property string to give help for a whole
Ofbiz screen could be difficult. The isUrl flag, in my opinion, should be
available to link to a completely stand-alone full HTML help web site.
Having the help pages in Confluence should also be considered.
It is sufficient that someone that has the space admin permission on Confluence
enables the export space feature to all users. Using this feature it is
possible to export the help pages from the Confluence as static HTML files in a
folder tree that can be copyed locally.
Another option is that Confluence admin performs such export whenever needed
and put the resulting .zip file available for download somewhere.
Sorry for the gif, you are right, it comes from JIRA website, i got from there
so long ago I didn't even remind. I will also delete it from the issue attached
files.
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.
[jira] Commented: (OFBIZ-1750) Online user help link icon
[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=12601981#action_12601981
]
Adrian Crum commented on OFBIZ-1750:
Bruno,
I would like to get this committed to the project because I think it is a great
idea. I can't commit your patch in its current state for a couple of reasons.
If you have some time, please update your patch with the following changes:
1. The screen widget code was recently refactored, so the patch needs to be
updated against the latest trunk revision.
2. Let's keep this simple: the container element attribute help-url will
contain something simple like help?topic=ProductFeatures - so we need a
request added to the common-controller.xml file to handle the help request.
Each component can override the common request to point to their own help
screen.
3. Add a simple help screen to the common component CommonScreens.xml file to
display the help topic. The help topic text is nothing more than a property in
a property file (each component will have its own) and the property key is the
same as the topic URL parameter. Each component can wrap the common help
screen with its own help screen decorator - which in turn loads its own help
properties file (in addition to common help text).
If have have any questions, just ask.
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_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.
[jira] Commented: (OFBIZ-1750) Online user help link icon
[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=12602169#action_12602169
]
Bruno Busco commented on OFBIZ-1750:
Adrian,
OK, I have got the idea. I will try to submit a patch for this soon.
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_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.
[jira] Commented: (OFBIZ-1750) Online user help link icon
[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=12590033#action_12590033
]
Bruno Busco commented on OFBIZ-1750:
The idea behind the prefix was that it should be possible to change all the
help urls modifying a single parameter in a single file.
For example, changing the helpurls.prefix variable from
http://docs.ofbiz.org/display/OFBENDUSER/ to
file://my_local_staic_confluence_export could switch the complete ofbiz
application from the standard confluence site to a local copy that can be
integrated with custom contents.
Since the helpurls.prefix is taken from a resource bundle it can be changed
based on locale so we can have a multilanguage help site structured as follows:
http://docs.ofbiz.org/display/OFBENDUSER/ for standard english help,
http://docs.ofbiz.org/display/OFBENDUSER/it for italian help,
http://docs.ofbiz.org/display/OFBENDUSER/fr for french help etc.
The specific help-ulrs strings that are put in the container attribute are
basically help keys and not urls (maybe the attribute name could be changed in
help-key). Every single piece of content has its own key and in a resource
property there is the association between keys and urls. In this way if, for
example, at the beginning of the help writing more cantainers are all described
in a single page and later these are split, only the resource mapping file must
be changed and not the container attributes.
The solution you suggest is also a good approach, I leave to you more expert
ofbizers the choice of the final one ;-) !
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
Attachments: help_links.jpg, help_links.patch, help_links1.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.
[jira] Commented: (OFBIZ-1750) Online user help link icon
[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=12590057#action_12590057
]
Adrian Crum commented on OFBIZ-1750:
Bruno,
Thanks - I understand why you are using the prefix.
The user's locale is already in the session and in the screen rendering context
- there is no need for locale suffixes. If a help screen needs the user's
locale to construct a URL, then it can be retrieved from the framework.
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
Attachments: help_links.jpg, help_links.patch, help_links1.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.
[jira] Commented: (OFBIZ-1750) Online user help link icon
[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=12589749#action_12589749
]
Adrian Crum commented on OFBIZ-1750:
I like the idea of adding an attribute that points to a help screen.
I'm not sure I understand what the purpose of the prefixes and such are. We
could set up a common help request in common-controller.xml and the specific
help would be a URL parameter. So, it would look something like this:
container style=screenlet
help-url=help?display=ProjectManagerApplicationRoles
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
Attachments: help_links.jpg, help_links.patch, help_links1.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.
[jira] Commented: (OFBIZ-1750) Online user help link icon
[
https://issues.apache.org/jira/browse/OFBIZ-1750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=12588386#action_12588386
]
Jacopo Cappellato commented on OFBIZ-1750:
--
Bruno,
in the patch there are a lot of lines that have been modified just to remove
the spaces... even if I agree that we could commit this without harm, it makes
the review process harder... would it be possible for you to provide a new
patch?
Thanks
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
Attachments: help_links.jpg, help_links.patch
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.
