docs/admin/search_interface.adoc

   1 Designing the patron search experience
   2 ======================================
   3
   4 Editing the formats select box options in the search interface
   5 ---------------------------------------------------------------
   6
   7 You may wish to remove, rename or organize the options in the formats select
   8 box. This can be accomplished from the staff client.
   9
  10 . From the staff client, navigate to *Administration -> Server Administration ->  Marc Coded
  11 Value Maps*
  12 . Select _Type_ from the *Record Attribute Type* select box.
  13 . Double click on the format type you wish to edit.
  14
  15 image::media/coded-value-1.png[Coded Value Map Format Editor]
  16
  17 To change the label for the type, enter a value in the *Search Label* field.
  18
  19 To  move the option to a top list separated by a dashed line from the others,
  20 check the *Is Simple Selector* check box.
  21
  22 To hide the type so that it does not appear in the search interface, uncheck the
  23 *OPAC Visible* checkbox.
  24
  25 Changes will be immediate.
  26
  27 Adding and removing search fields in advanced search
  28 -----------------------------------------------------
  29
  30 It is possible to add and remove search fields on the advanced search page by
  31 editing the _opac/parts/config.tt2_ file in your template directory. Look for
  32 this section of the file:
  33
  34 ----
  35 search.adv_config = [
  36     {adv_label => l("Item Type"), adv_attr => ["mattype", "item_type"]},
  37     {adv_label => l("Item Form"), adv_attr => "item_form"},
  38     {adv_label => l("Language"),  adv_attr => "item_lang"},
  39     {adv_label => l("Audience"),  adv_attr => ["audience_group", "audience"], adv_break => 1},
  40     {adv_label => l("Video Format"), adv_attr => "vr_format"},
  41     {adv_label => l("Bib Level"), adv_attr => "bib_level"},
  42     {adv_label => l("Literary Form"), adv_attr => "lit_form", adv_break => 1},
  43     {adv_label => l("Search Library"), adv_special => "lib_selector"},
  44     {adv_label => l("Publication Year"), adv_special => "pub_year"},
  45     {adv_label => l("Sort Results"), adv_special => "sort_selector"},
  46 ];
  47 ----
  48
  49 For example, if you delete the line:
  50
  51 ----
  52 {adv_label => l("Language"),  adv_attr => "item_lang"},
  53 ----
  54
  55 the language field will no longer appear on your advanced search page. Changes
  56 will appear immediately after you save your changes.
  57
  58 You can also add fields based on Search Facet Groups that you create in the
  59 staff client's Local Administration menu. This can be helpful if you want to
  60 simplify your patrons' experience by presenting them with only certain
  61 limiters (e.g. the most commonly used languages in your area).  To do this,
  62
  63 . Click *Administration -> Local Administration -> Search Filter Groups*.
  64 . Click *New*.
  65 . Enter descriptive values into the code and label fields.  The owner needs to
  66 be set to your consortium.
  67 . Once the Facet Group is created, click on the blue hyperlinked code value.
  68 . Click the *New* button to create the necessary values for your field.
  69 . Go to the _opac/parts/config.tt2_ file, and add a line like the following,
  70 where *Our Library's Field* is the name you'd like to be displayed next to
  71 your field, and *facet_group_code* is the code you've added using the staff
  72 client.
  73 +
  74 ----
  75  {adv_label => l("Our Library's Field"), adv_filter => "facet_group_code"},
  76 ----
  77
  78 Changing the display of facets and facet groups
  79 -----------------------------------------------
  80
  81 Facets can be reordered on the search results page by editing the
  82 _opac/parts/config.tt2_ file in your template directory.
  83
  84 Edit the following section of _config.tt2_, changing the order of the facet
  85 categories according to your needs:
  86
  87 ----
  88
  89 facet.display = [
  90     {facet_class => 'author',  facet_order => ['personal', 'corporate']},
  91     {facet_class => 'subject', facet_order => ['topic']},
  92     {facet_class => 'series',  facet_order => ['seriestitle']},
  93     {facet_class => 'subject', facet_order => ['name', 'geographic']}
  94 ];
  95
  96 ----
  97
  98 You may also change the default number of facets appearing under each category
  99 by editing the _facet.default_display_count_ value in _config.tt2_. The default
 100 value is 5.
 101
 102 Facilitating search scope changes
 103 ---------------------------------
 104
 105 Users often search in a limited scope, such as only searching items in their
 106 local library.  When they aren't able find materials that meet their needs in
 107 a limited scope, they may wish to repeat their search in a system-wide or
 108 consortium-wide scope.  Evergreen provides an optional button and checkbox
 109 to alter the depth of the search to a defined level.
 110
 111 The button and checkbox are both enabled by default and can be configured
 112 in the Depth Button/Checkbox section of config.tt2.
 113
 114 Noteworthy settings related to these features include:
 115
 116 * `ctx.depth_sel_checkbox` -- set this to 1 to display the checkbox, 0 to hide it.
 117 * `ctx.depth_sel_button` -- set this to 1 to display the button, 0 to hide it.
 118 * `ctx.depth_sel_depth` -- the depth that should be applied by the button and
 119 checkbox.  A value of 0 would typically search the entire consortium, and 1 would
 120 typically search the library's system.
 121
 122