[OPEN-ILS-DEV] [OPEN-ILS-DOCUMENTATION] staff client context help feature

Mon May 21 08:07:50 EDT 2012

Hi Robert,

I believe this works but there are no delivered context help files right 
now.

For example, you can create a base web page at
/openils/var/web/help.html for example and this will display if no other 
help is found.

However, you can create context help by adding it for each screen, e.g. 
patron search

/openils/var/web/xul/rel_2_1_0/server/patron/display_horiz.xul.custom_help.html

As long as you have a start and close html tag it seems to work
<html></html>

If you follow your apache error log as you navigate from page to page 
you can find the missing filenames as you click the help button.
Thanks
Jonathan

On 15/05/2012 15:57, Soulliere, Robert wrote:
> Hi all,
>
> I was digging around for information on context help. I was hoping to
> experiment to see what options were possible in regards to directing
> users to appropriate docs on the evergreen server or external servers.
>
> The only information I found was this scratchpad info from 2010:
>
> http://open-ils.org/dokuwiki/doku.php?id=scratchpad:custom_help
>
> However, in testing I found that context help was only working for the
> OPAC search page even when help.html pages were in place in the
> prescribed locations. I tested on an older 2.2 master staff client and
> 2.0 version with the same results. I also found that the debug console
> did not provide the information that it was supposed to. I did not see
> messages such as:
>
> set_help_context:
> {"protocol":"http:","hostname":"acq.open-ils.org","port":"","pathname":"/xul/acq_20100513/server/circ/checkin.xul","src":""}
>
> nor
>
> helpwidget: testing <http://acq.open-ils.org/help.html>
>
> for example.
>
> I would like to get information about the current state of this feature
> and a good starting point (code/page reference) if I want to experiment
> with pointing context help to different sources on my test server.
>
> I also wonder if this is a good time to reopen the discussion on this
> feature?
>
> Thanks,
>
> Robert
>
>
> ------------------------------------------------------------------------
> This E-mail contains privileged and confidential information intended
> only for the individual or entity named in the message. If the reader
> of this message is not the intended recipient, or the agent responsible
> to deliver it to the intended recipient, you are hereby notified that
> any review, dissemination, distribution or copying of this communication
> is prohibited. If this communication was received in error, please
> notify the sender by reply E-mail immediately, and delete and destroy
> the original message.
>
>
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation

-- 

Jonathan Field
Technical Director, PTFS Europe Limited
Content Management and Library Solutions
http://www.ptfs-europe.com