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

[Dan Scott]

On Sat, May 12, 2012 at 04:18:17PM -0400, Soulliere, Robert wrote:
> An update:
> 
> I went ahead and committed some of the content and processed the
> documents.
> 
<snip> 
> 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.

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