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

[Soulliere, Robert]

An update:

I went ahead and committed some of the content and processed the documents.

You can see commits here:
https://github.com/rsoulliere/Evergreen-DocBook/commits/master

I also processed the docs so commits are now live in the official docs.

I bypassed the acquisitions and cataloguing content because some might already be ready and I know a few folks are working on those parts and hope they can review these sections.

I also added a new "Using the Staff Client" part of the documentation to cover some of the general usage (logging in, navigating, sorting colums, etc...) content., I am not sure if that has to be reorganized or if all of this fits properly into this separate heading.

I added my additions to the 2.2 outline here:
http://open-ils.org/dokuwiki/doku.php?id=evergreen-docs_2.2:outline

I also experimented with linking from the release notes. I created a link directly to the auto suggest feature from the release notes.  See; http://docs.evergreen-ils.org/2.2/_new_features.html

I remove the whole paragraph regarding the Book of Evergreen and just linked the first occurance of "auto suggest feature" with the first paragraph. Is that what you had in mind Dan? Would that work? Since this particular documentation chapters is in its own page and will be static, I created an external style link to the page:
http://docs.evergreen-ils.org/2.2/_auto_suggest_in_catalog_search_2.html. That might be more easier then creating or finding the right anchor references.

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


Regards  and have a great weekend.
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 Dan Scott [dan at coffeecode.net]
Sent: May 12, 2012 1:34 PM
To: Documentation discussion for Evergreen software
Cc: gmcharlt at esilibrary.com
Subject: Re: [OPEN-ILS-DOCUMENTATION] Auto Suggest in Catalog Search documentation

On Sat, May 12, 2012 at 08:51:58AM -0400, Soulliere, Robert wrote:
> Hi,
>
> I was attempting to turn on the new TPAC search box auto suggest
> feature on a test server, but was unable to find the documentation.
> The release notes indicate that this feature is documented in the
> official documentation.
>
> Release notes say:
>
> "This feature is not turned on by default. You must turn it on in the Admin module."

(As an aside, the feature _is_ turned on by default, in my experience.)

My preference would be to avoid making any references from the Release
Notes to the more complete documentation until such time as that
documentation actually exists in the official Evergreen docs. We can
always go back and add links from the Release Notes to the complete
documentation as the features get full documentation.

As I was adding Kathy's contributions to the release notes, I noticed
that she had followed Sally's lead in pointing at the official docs.
I like the idea of leading readers to more complete docs, but made a
mental note that the repetition of that phrase and the lack of any
specific link was distracting, and thought we should discuss that later
(hi!). Also, I don't think "The Book of Evergreen" has been the title
for years :)

I wondered whether we could use a shorter phrase and/or a special icon
(along the lines of admonitions?) that linked directly to the pertinent
section of the docs.  Processing the release notes in and of themselves
might lead to warnings about links to missing sections (although maybe
there are ways around that with IFDEFs), but when the release notes are
processed with the official docs, then the link could take the reader
directly to the right area, rather than:

1. taking them back to the docs.evergreen-ils.org page
2. choosing a format
3. scan the table of contents or index or search for the corresponding
   section

As a reminder, the link syntax is basically:

<<anchor_in_a_document,Complete documentation>>

where "Complete documentation" would be the text of a link that leads to
the matching anchor somewhere else in the document:

[[anchor_in_a_document]]

_______________________________________________
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.