[OPEN-ILS-DOCUMENTATION] Staff client help menu and files

Jason Etheridge jason at esilibrary.com
Sun Sep 26 03:41:51 EDT 2010


Jeremy++

> -How should help files display in the client?  Will they open in new tab, a
> column in the active tab, as a pop-up window, or?

Currently the behavior would be to pop-up a new window, but we could
change it, or even make it configurable in the long run.

> -Is there a list of staff client screens with associated help file names, or
> do we need to copy them from the console as Jason describes on the wiki?

There's another option here that wasn't documented (har), and that's
the ability for us to dictate the help file for a given context.  So
instead of deriving the help filename from a UI's filename in the
source code, we could modify the source code and have it look first
for something arbitrary first.

So for example, the Check In interface would normally start first by
looking for http://hostname/xul/stamp_id/server/circ/checkin.xul.custom_help.html,
but we could change the behavior so that instead it starts with say,
http://hostname/help/circulation.html

This takes a bit of effort and someone with SVN commit privileges to
do, but I'm willing to do it if it's easier for DIG.

-- 
Jason Etheridge
 | VP, Tactical Development
 | Equinox Software, Inc. / Your Library's Guide to Open Source
 | phone:  1-877-OPEN-ILS (673-6457)
 | email:  jason at esilibrary.com
 | web:  http://www.esilibrary.com


More information about the OPEN-ILS-DOCUMENTATION mailing list