[OPEN-ILS-GENERAL] Writing an Evergreen manual

Jason Etheridge phasefx at gmail.com
Tue Oct 9 12:15:15 EDT 2007


On 10/9/07, Murphy, Sally <smurphy at georgialibraries.org> wrote:
> Also, what kind of support does doc books have for graphics, and formatting
> pages with them?  Focusing on end-user stuff, there will be lots of
> screenshots, diagrams of menus, pictures of icons, and such.

Thinking along those lines, it would be great if the documentation
framework could optionally alert folks when there are pertinent
changes to the source code.  For example, if you have a screenshot of
the Item Status staff interface, perhaps the framework could associate
it with an RSS feed of the changelog for the corrresponding XUL and
CSS files, and flag anything that might require a new screenshot
(maybe we could require that commiters embed a magical keyword into
the changelog like DOC_UPDATE_NEEDED).  If a documenter doesn't know
anything about internals, then no biggie, just no magic until someone
else comes along and adds the pertinent meta-data.

Or am I overthinking this and it would just be too complicated to get
something like that working? :)

-- 
Jason Etheridge
 | VP, Community Support and Advocacy
 | Equinox Software, Inc. / The Evergreen Experts
 | phone:  1-877-OPEN-ILS (673-6457)
 | email:  jason at esilibrary.com
 | web:  http://www.esilibrary.com


More information about the Open-ils-general mailing list