[OPEN-ILS-DOCUMENTATION] Auto Suggest in Catalog Search documentation

Soulliere, Robert robert.soulliere at mohawkcollege.ca
Mon May 14 14:15:42 EDT 2012


I clicked send before finishing...

I also cleaned up the 80 column width issue you reported.
https://github.com/rsoulliere/Evergreen-DocBook/commit/34014ea938cd107d37ae51129ef2285fe305536c

I cleaned some of the root.txt paragraphs. I will try to clean up more as I edit other files. I also set my vim program to create a new line at 80 chars so hopefully it wont happen as often by me...

Working with the links in both the stand alone release notes and the documentation might be tricky. If we go with the official docs as the release notes we can use the anchor approach Dan has suggested.

Thanks,
Robert



Robert Soulliere, BA (Hons), MLIS
Systems Librarian
Mohawk College Library
robert.soulliere at mohawkcollege.ca
Telephone: 905 575 1212 x3936
Fax: 905 575 2011
________________________________________
From: open-ils-documentation-bounces at list.georgialibraries.org [open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of Soulliere, Robert [robert.soulliere at mohawkcollege.ca]
Sent: May 14, 2012 1:59 PM
To: Documentation discussion for Evergreen software
Subject: Re: [OPEN-ILS-DOCUMENTATION] Auto Suggest in Catalog Search documentation

Hi Dan,


It looks good in the HTML output; I much prefer the inline link to the
"Full documentation is available..." approach. One caveat: creating an
external style link instead of an internal link means that PDF and ePub
will also link to the static HTML page, which could be annoying.

Oops, I forgot about the mulitple formats (PDF, ePub,).

> Details on that commit are here:
> https://github.com/rsoulliere/Evergreen-DocBook/commit/1f665ea0bab3f96ce0210c315dd578e0f65b4098

One nit: can we please try to stay to 80 columns or less, at least for
those documents that are already formatted that way? Keeping lines
relatively short means that, when changes do happen, it's a lot easier
to spot exactly what changed on a line that's 80 characters or less,
rather than, say, 200 characters.

Also: as long as we're going to continue maintaining the docs in a
separate repository, with overlapping files like the release notes and
install instructions, we need to figure out how to keep the files in
sync in each repository. I know, I know, I'm the guy who had the bright
idea of single-sourcing these docs in the first place... :)

Thanks for all of your work on this, Robert!
_______________________________________________
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.
_______________________________________________
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.


More information about the OPEN-ILS-DOCUMENTATION mailing list