Docs: Documentation for default metarecord search
authorKathy Lussier <klussier@masslnc.org>
Tue, 2 May 2017 17:33:54 +0000 (13:33 -0400)
committerKathy Lussier <klussier@masslnc.org>
Tue, 2 May 2017 17:33:54 +0000 (13:33 -0400)
Adding documentation on how to configure a default metarecord search in the
admin section. The catalog section also containts a tip about this option with
a link to the admin section for further details on how to configure it.

Signed-off-by: Kathy Lussier <klussier@masslnc.org>
docs/opac/new_skin_customizations.adoc
docs/opac/tpac_meta_record_holds.adoc

index 28d9b19..7ad5e79 100644 (file)
@@ -40,6 +40,8 @@ that include placeholder images, text, or links that you should override.
 
 NOTE: All paths are relative to `/openils/var/templates/opac`
 
+[[configtt2]]
+
 * `parts/config.tt2`: contains many configuration settings that affect the
   behavior of the TPAC, including:
   ** hiding the *Place Hold* button for available items
@@ -55,6 +57,10 @@ NOTE: All paths are relative to `/openils/var/templates/opac`
   ** disallowing password or e-mail changes (useful for libraries that use centralized authentication or single sign-on systems)
   ** displaying a maintenance message in the public catalog and KPAC (this is controlled by the _ctx.maintenance_message_ variable)
   ** displaying previews of books when available from Google Books.  This is controlled by the _ctx.google_books_preview_ variable, which is set to 0 by default to protect the privacy of users who might not want to share their browsing behavior with Google.
+  ** disabling the "Group Formats and Editions" search. This is controlled by 
+setting the metarecords.disabled variable to 1.
+  ** setting the default search to a 'Group Formats and Editions' search. This
+is done by setting the search.metarecord_default variable to 1.
 * `parts/footer.tt2` and `parts/topnav_links.tt2`: contains customizable
   links. Defaults like 'Link 1' will not mean much to your users!
 * `parts/homesearch.tt2`: holds the large Evergreen logo on the home page
index 6d89551..d20e3da 100644 (file)
@@ -3,12 +3,20 @@ TPAC Metarecord Search and Metarecord Level Holds
 
 Metarecords are compilations of individual bibliographic records that represent the same work. This compilation allows for several records to be represented on a single line on the TPAC search results page, which can help to reduce result duplications.
 
+
 *Advanced Search Page*
 
 Selecting the *Group Formats and Editions* checkbox on the Advanced Search page allows the user to perform a metarecord search.
 
 image::media/advsrchpg_1.jpg[]
 
+[TIP]
+Administrators can also configure the catalog to default to a *Group Formats and
+Editions* search by enabling the <<configtt2, relevant config.tt2 setting>> on
+the server. Setting this option will pre-select the checkbox on the Advanced 
+Search and Search Result Pages. Users can remove the checkmark, but new searches
+will revert to the default search behavior.
+
 *Search Results Page*
 
 Within the Search Results page, users can also refine their searches and filter on metarecord search results by selecting the *Group Formats and Editions* checkbox.