Linking OFBIZ to the on-line help system

[Bruno Busco]

After the discussion we had in
http://www.nabble.com/Loading-Raw-HTML-td16595109.html
I am trying to modify ofbiz to optionally include a little help icon in the
screenlet title bar.
What I want to obtais is the possibility to specify for every container an
help page link.
I am not expert of Ofbiz and of Java too but I want use this as an exercize
to grow my experience up.

My roadmap is:
1 - add a little help icon image (help_yellow.gif) to ofbiz

2 - add a "helpHomeUrl" property in general.properies

3 - add a new "helplink" property to the container tag to let the programmer
to link an help page to every single UI element.
When the container is rendered the following HTML should be added in the
container.
    <a class="helpLink" target="_ofbizhelp" href="HELPURL">
        <img width="16" height="16" align="absmiddle" title="Get online help
about Using Ofbiz" src="/images/help_yellow.gif"/>
    </a>
Where HELPURL is a string obtained from the helpHomeUrl, the helplink
property and perhaps the actual locale

4- add something in the main.css to make the little help icon displayed
inline on the right of the container area

So, after the trivial step 1, skipped step 2 for the moment, I started
navigating the code to do step 3.
I have seen that the screenlet container is someting that is built in two
(at least) different ways in .ftl files and in screens.xml files.
I have done it for a single .ftl file inserting the HTML code by hand but
now I want to make it for the screens.xml files. I have tried to modify the
HtmlScreenRenderer.java but I get no effect at all changing this file
ant-building and the startofbizing.

Could someone help me?

-Bruno

[Bruno Busco]

Ooops,
I have resolved. I was modifying the renderScreenletBegin function instead
of the renderContainerBegin function.
Now I can continue on my road-map...

-Bruno

2008/4/12, Bruno Busco <[hidden email]>:

>
> After the discussion we had in
> http://www.nabble.com/Loading-Raw-HTML-td16595109.html
> I am trying to modify ofbiz to optionally include a little help icon in
> the screenlet title bar.
> What I want to obtais is the possibility to specify for every container an
> help page link.
> I am not expert of Ofbiz and of Java too but I want use this as an
> exercize to grow my experience up.
>
> My roadmap is:
> 1 - add a little help icon image (help_yellow.gif) to ofbiz
>
> 2 - add a "helpHomeUrl" property in general.properies
>
> 3 - add a new "helplink" property to the container tag to let the
> programmer to link an help page to every single UI element.
> When the container is rendered the following HTML should be added in the
> container.
>     <a class="helpLink" target="_ofbizhelp" href="HELPURL">
>         <img width="16" height="16" align="absmiddle" title="Get online
> help about Using Ofbiz" src="/images/help_yellow.gif"/>
>     </a>
> Where HELPURL is a string obtained from the helpHomeUrl, the helplink
> property and perhaps the actual locale
>
> 4- add something in the main.css to make the little help icon displayed
> inline on the right of the container area
>
> So, after the trivial step 1, skipped step 2 for the moment, I started
> navigating the code to do step 3.
> I have seen that the screenlet container is someting that is built in two
> (at least) different ways in .ftl files and in screens.xml files.
> I have done it for a single .ftl file inserting the HTML code by hand but
> now I want to make it for the screens.xml files. I have tried to modify the
> HtmlScreenRenderer.java but I get no effect at all changing this file
> ant-building and the startofbizing.
>
> Could someone help me?
>
> -Bruno
>

[Bruno Busco]

OK,
I have worked a little bit on this and came to a solution that I have
submitted here:
https://issues.apache.org/jira/browse/OFBIZ-1750

Please review and eventually integrate!

-Bruno

2008/4/12, Bruno Busco <[hidden email]>:

>
> Ooops,
> I have resolved. I was modifying the renderScreenletBegin function instead
> of the renderContainerBegin function.
> Now I can continue on my road-map...
>
> -Bruno
>
> 2008/4/12, Bruno Busco <[hidden email]>:
> >
> > After the discussion we had in
> > http://www.nabble.com/Loading-Raw-HTML-td16595109.html
> > I am trying to modify ofbiz to optionally include a little help icon in
> > the screenlet title bar.
> > What I want to obtais is the possibility to specify for every container
> > an help page link.
> > I am not expert of Ofbiz and of Java too but I want use this as an
> > exercize to grow my experience up.
> >
> > My roadmap is:
> > 1 - add a little help icon image (help_yellow.gif) to ofbiz
> >
> > 2 - add a "helpHomeUrl" property in general.properies
> >
> > 3 - add a new "helplink" property to the container tag to let the
> > programmer to link an help page to every single UI element.
> > When the container is rendered the following HTML should be added in the
> > container.
> >     <a class="helpLink" target="_ofbizhelp" href="HELPURL">
> >         <img width="16" height="16" align="absmiddle" title="Get online
> > help about Using Ofbiz" src="/images/help_yellow.gif"/>
> >     </a>
> > Where HELPURL is a string obtained from the helpHomeUrl, the helplink
> > property and perhaps the actual locale
> >
> > 4- add something in the main.css to make the little help icon displayed
> > inline on the right of the container area
> >
> > So, after the trivial step 1, skipped step 2 for the moment, I started
> > navigating the code to do step 3.
> > I have seen that the screenlet container is someting that is built in
> > two (at least) different ways in .ftl files and in screens.xml files.
> > I have done it for a single .ftl file inserting the HTML code by hand
> > but now I want to make it for the screens.xml files. I have tried to modify
> > the HtmlScreenRenderer.java but I get no effect at all changing this file
> > ant-building and the startofbizing.
> >
> > Could someone help me?
> >
> > -Bruno
> >
>
>

[Jacopo Cappellato-3]

Bruno, I'll definitely look at your patch, thanks.
An idea we could also consider is to use the screen name (or form  
name) to compose the name of the help page: in this way we could have  
a link tht points to an help page even if we don't specify the url in  
the screen's container (if the page is not available we could return a  
default page). There are pros and cons with this approach but it is  
definitely something we could consider.

Jacopo


On Apr 13, 2008, at 10:46 AM, Bruno Busco wrote:

> OK,
> I have worked a little bit on this and came to a solution that I have
> submitted here:
> https://issues.apache.org/jira/browse/OFBIZ-1750
>
> Please review and eventually integrate!
>
> -Bruno
>
> 2008/4/12, Bruno Busco <[hidden email]>:
>>
>> Ooops,
>> I have resolved. I was modifying the renderScreenletBegin function  
>> instead
>> of the renderContainerBegin function.
>> Now I can continue on my road-map...
>>
>> -Bruno
>>
>> 2008/4/12, Bruno Busco <[hidden email]>:
>>>
>>> After the discussion we had in
>>> http://www.nabble.com/Loading-Raw-HTML-td16595109.html
>>> I am trying to modify ofbiz to optionally include a little help  
>>> icon in
>>> the screenlet title bar.
>>> What I want to obtais is the possibility to specify for every  
>>> container
>>> an help page link.
>>> I am not expert of Ofbiz and of Java too but I want use this as an
>>> exercize to grow my experience up.
>>>
>>> My roadmap is:
>>> 1 - add a little help icon image (help_yellow.gif) to ofbiz
>>>
>>> 2 - add a "helpHomeUrl" property in general.properies
>>>
>>> 3 - add a new "helplink" property to the container tag to let the
>>> programmer to link an help page to every single UI element.
>>> When the container is rendered the following HTML should be added  
>>> in the
>>> container.
>>>    <a class="helpLink" target="_ofbizhelp" href="HELPURL">
>>>        <img width="16" height="16" align="absmiddle" title="Get  
>>> online
>>> help about Using Ofbiz" src="/images/help_yellow.gif"/>
>>>    </a>
>>> Where HELPURL is a string obtained from the helpHomeUrl, the  
>>> helplink
>>> property and perhaps the actual locale
>>>
>>> 4- add something in the main.css to make the little help icon  
>>> displayed
>>> inline on the right of the container area
>>>
>>> So, after the trivial step 1, skipped step 2 for the moment, I  
>>> started
>>> navigating the code to do step 3.
>>> I have seen that the screenlet container is someting that is built  
>>> in
>>> two (at least) different ways in .ftl files and in screens.xml  
>>> files.
>>> I have done it for a single .ftl file inserting the HTML code by  
>>> hand
>>> but now I want to make it for the screens.xml files. I have tried  
>>> to modify
>>> the HtmlScreenRenderer.java but I get no effect at all changing  
>>> this file
>>> ant-building and the startofbizing.
>>>
>>> Could someone help me?
>>>
>>> -Bruno
>>>
>>
>>

[Bruno Busco]

Jacopo,
yes the system could be improved. I think anyway that the one that I propose
should be a good starting point.
There is the possibility to attach an help page, if needed, to every single
screenlet or even smaller container.

-Bruno


2008/4/13, Jacopo Cappellato <[hidden email]>:

>
> Bruno, I'll definitely look at your patch, thanks.
> An idea we could also consider is to use the screen name (or form name) to
> compose the name of the help page: in this way we could have a link tht
> points to an help page even if we don't specify the url in the screen's
> container (if the page is not available we could return a default page).
> There are pros and cons with this approach but it is definitely something we
> could consider.
>
> Jacopo
>
>
> On Apr 13, 2008, at 10:46 AM, Bruno Busco wrote:
>
> > OK,
> > I have worked a little bit on this and came to a solution that I have
> > submitted here:
> > https://issues.apache.org/jira/browse/OFBIZ-1750
> >
> > Please review and eventually integrate!
> >
> > -Bruno
> >
> > 2008/4/12, Bruno Busco <[hidden email]>:
> >
> > >
> > > Ooops,
> > > I have resolved. I was modifying the renderScreenletBegin function
> > > instead
> > > of the renderContainerBegin function.
> > > Now I can continue on my road-map...
> > >
> > > -Bruno
> > >
> > > 2008/4/12, Bruno Busco <[hidden email]>:
> > >
> > > >
> > > > After the discussion we had in
> > > > http://www.nabble.com/Loading-Raw-HTML-td16595109.html
> > > > I am trying to modify ofbiz to optionally include a little help icon
> > > > in
> > > > the screenlet title bar.
> > > > What I want to obtais is the possibility to specify for every
> > > > container
> > > > an help page link.
> > > > I am not expert of Ofbiz and of Java too but I want use this as an
> > > > exercize to grow my experience up.
> > > >
> > > > My roadmap is:
> > > > 1 - add a little help icon image (help_yellow.gif) to ofbiz
> > > >
> > > > 2 - add a "helpHomeUrl" property in general.properies
> > > >
> > > > 3 - add a new "helplink" property to the container tag to let the
> > > > programmer to link an help page to every single UI element.
> > > > When the container is rendered the following HTML should be added in
> > > > the
> > > > container.
> > > >   <a class="helpLink" target="_ofbizhelp" href="HELPURL">
> > > >       <img width="16" height="16" align="absmiddle" title="Get
> > > > online
> > > > help about Using Ofbiz" src="/images/help_yellow.gif"/>
> > > >   </a>
> > > > Where HELPURL is a string obtained from the helpHomeUrl, the
> > > > helplink
> > > > property and perhaps the actual locale
> > > >
> > > > 4- add something in the main.css to make the little help icon
> > > > displayed
> > > > inline on the right of the container area
> > > >
> > > > So, after the trivial step 1, skipped step 2 for the moment, I
> > > > started
> > > > navigating the code to do step 3.
> > > > I have seen that the screenlet container is someting that is built
> > > > in
> > > > two (at least) different ways in .ftl files and in screens.xml
> > > > files.
> > > > I have done it for a single .ftl file inserting the HTML code by
> > > > hand
> > > > but now I want to make it for the screens.xml files. I have tried to
> > > > modify
> > > > the HtmlScreenRenderer.java but I get no effect at all changing this
> > > > file
> > > > ant-building and the startofbizing.
> > > >
> > > > Could someone help me?
> > > >
> > > > -Bruno
> > > >
> > > >
> > >
> > >
>

[Bruno Busco]

Jacopo,
I have seen that the <link> tag can be used to get something similar without
changing the java code.
I have put this tag:
<link target="${uiHelpUrlsMap.ProjectManagerApplicationRoles}"
style="help-link"/>
soon after the opening container tag and the same icon is displayed.

Unfortunately the url is relative to ofbiz home but may be with othe <link>
tag options we can have absolute urls.
Where can I find a complete reference of the <link> tag?

-Bruno

2008/4/13, Bruno Busco <[hidden email]>:

>
> Jacopo,
> yes the system could be improved. I think anyway that the one that I
> propose should be a good starting point.
> There is the possibility to attach an help page, if needed, to every
> single screenlet or even smaller container.
>
> -Bruno
>
>
> 2008/4/13, Jacopo Cappellato <[hidden email]>:
> >
> > Bruno, I'll definitely look at your patch, thanks.
> > An idea we could also consider is to use the screen name (or form name)
> > to compose the name of the help page: in this way we could have a link tht
> > points to an help page even if we don't specify the url in the screen's
> > container (if the page is not available we could return a default page).
> > There are pros and cons with this approach but it is definitely something we
> > could consider.
> >
> > Jacopo
> >
> >
> > On Apr 13, 2008, at 10:46 AM, Bruno Busco wrote:
> >
> > > OK,
> > > I have worked a little bit on this and came to a solution that I have
> > > submitted here:
> > > https://issues.apache.org/jira/browse/OFBIZ-1750
> > >
> > > Please review and eventually integrate!
> > >
> > > -Bruno
> > >
> > > 2008/4/12, Bruno Busco <[hidden email]>:
> > >
> > > >
> > > > Ooops,
> > > > I have resolved. I was modifying the renderScreenletBegin function
> > > > instead
> > > > of the renderContainerBegin function.
> > > > Now I can continue on my road-map...
> > > >
> > > > -Bruno
> > > >
> > > > 2008/4/12, Bruno Busco <[hidden email]>:
> > > >
> > > > >
> > > > > After the discussion we had in
> > > > > http://www.nabble.com/Loading-Raw-HTML-td16595109.html
> > > > > I am trying to modify ofbiz to optionally include a little help
> > > > > icon in
> > > > > the screenlet title bar.
> > > > > What I want to obtais is the possibility to specify for every
> > > > > container
> > > > > an help page link.
> > > > > I am not expert of Ofbiz and of Java too but I want use this as an
> > > > > exercize to grow my experience up.
> > > > >
> > > > > My roadmap is:
> > > > > 1 - add a little help icon image (help_yellow.gif) to ofbiz
> > > > >
> > > > > 2 - add a "helpHomeUrl" property in general.properies
> > > > >
> > > > > 3 - add a new "helplink" property to the container tag to let the
> > > > > programmer to link an help page to every single UI element.
> > > > > When the container is rendered the following HTML should be added
> > > > > in the
> > > > > container.
> > > > >   <a class="helpLink" target="_ofbizhelp" href="HELPURL">
> > > > >       <img width="16" height="16" align="absmiddle" title="Get
> > > > > online
> > > > > help about Using Ofbiz" src="/images/help_yellow.gif"/>
> > > > >   </a>
> > > > > Where HELPURL is a string obtained from the helpHomeUrl, the
> > > > > helplink
> > > > > property and perhaps the actual locale
> > > > >
> > > > > 4- add something in the main.css to make the little help icon
> > > > > displayed
> > > > > inline on the right of the container area
> > > > >
> > > > > So, after the trivial step 1, skipped step 2 for the moment, I
> > > > > started
> > > > > navigating the code to do step 3.
> > > > > I have seen that the screenlet container is someting that is built
> > > > > in
> > > > > two (at least) different ways in .ftl files and in screens.xml
> > > > > files.
> > > > > I have done it for a single .ftl file inserting the HTML code by
> > > > > hand
> > > > > but now I want to make it for the screens.xml files. I have tried
> > > > > to modify
> > > > > the HtmlScreenRenderer.java but I get no effect at all changing
> > > > > this file
> > > > > ant-building and the startofbizing.
> > > > >
> > > > > Could someone help me?
> > > > >
> > > > > -Bruno
> > > > >
> > > > >
> > > >
> > > >
> >
>