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

[Soulliere, Robert]

Thanks Jeremy, This is an excellent approach.

Jason, could the workflow go something like this:

1) DIG determines a static location for the context-sensitive help files for a specific version of Evergreen. E.g. docs.evergreen-ils.org/2.0/help/

2) DIG generates the html help files using Jeremy's style sheets.

3) Developers could link to the appropriate help files as they are writing the code or add links to the existing code.

Would that work?


Robert

-----Original Message-----
From: open-ils-documentation-bounces at list.georgialibraries.org [mailto:open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of Jason Etheridge
Sent: Sunday, September 26, 2010 3:42 AM
To: Documentation discussion for Evergreen software
Subject: Re: [OPEN-ILS-DOCUMENTATION] Staff client help menu and files

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
_______________________________________________
OPEN-ILS-DOCUMENTATION mailing list
OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation

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.