From: Andrea Buntz Neiman Date: Fri, 9 Apr 2021 13:50:09 +0000 (-0400) Subject: Docs: Library Groups X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=0127f46755b079628e931dbadd2b91d36e4d5146;p=Evergreen.git Docs: Library Groups Signed-off-by: Andrea Buntz Neiman Signed-off-by: Galen Charlton --- diff --git a/docs/modules/admin/assets/images/media/group_map_dropdown.png b/docs/modules/admin/assets/images/media/group_map_dropdown.png new file mode 100644 index 0000000000..d8a2056068 Binary files /dev/null and b/docs/modules/admin/assets/images/media/group_map_dropdown.png differ diff --git a/docs/modules/admin/assets/images/media/group_map_ou_dropdown.png b/docs/modules/admin/assets/images/media/group_map_ou_dropdown.png new file mode 100644 index 0000000000..d7bc748fc1 Binary files /dev/null and b/docs/modules/admin/assets/images/media/group_map_ou_dropdown.png differ diff --git a/docs/modules/admin/assets/images/media/new_group_map.png b/docs/modules/admin/assets/images/media/new_group_map.png new file mode 100644 index 0000000000..3804f9ee85 Binary files /dev/null and b/docs/modules/admin/assets/images/media/new_group_map.png differ diff --git a/docs/modules/admin/assets/images/media/new_library_group.png b/docs/modules/admin/assets/images/media/new_library_group.png new file mode 100644 index 0000000000..7d2218de47 Binary files /dev/null and b/docs/modules/admin/assets/images/media/new_library_group.png differ diff --git a/docs/modules/admin/assets/images/media/new_library_group_2.png b/docs/modules/admin/assets/images/media/new_library_group_2.png new file mode 100644 index 0000000000..6ef737b82f Binary files /dev/null and b/docs/modules/admin/assets/images/media/new_library_group_2.png differ diff --git a/docs/modules/admin/pages/library_groups_admin.adoc b/docs/modules/admin/pages/library_groups_admin.adoc new file mode 100644 index 0000000000..83d94b5481 --- /dev/null +++ b/docs/modules/admin/pages/library_groups_admin.adoc @@ -0,0 +1,71 @@ += Library Groups Administration + +indexterm:[Library Groups,Searching] + +The xref:opac:using_the_public_access_catalog.adoc#library_groups[Library Groups] search feature revives a longstanding internal concept in Evergreen called “Lassos,” which allows an administrator to define a group of organizational units for searching outside of the standard organizational unit hierarchy. + +Use case examples include creating a group of law or science libraries +within a university consortium, or grouping all school libraries +together within a mixed school/public library. + +== Creating a new Library Group + +To create a new Library Group, you must have the ADMIN_LIBRARY_GROUPS +permission. This permission will need to be assigned as needed to staff +accounts and/or permission groups by an administrator. No permission +groups will have this permission by default. + +Navigate to *Administration -> Server Administration* and select *Library +Groups*. + +Select *New Library Group*. + +image::media/new_library_group.png[New Library Group] + +Name your Library Group. + +image::media/new_library_group_2.png[Naming Your New Library Group] + +[NOTE] +==== +If you want the Library Group to be visible at all locations, +check the *Global* checkbox. By default this is unchecked and therefore +the Library Group will be visible only at locations that belong to the +Library Group. + +Global Library Groups should only be used in Consortia using catalogs +WITHOUT a locg parameter or its equivalent (org hiding, separate +hostnames) to start at a particular context location. + +Consortia that allow all users to search all locations should, as a +matter of best practice, make all Library Groups global. +==== + +When you are finished, click *Save*. + +Return to *Server Administration* and select *Library Group Maps*. + +. Select *New Library Group Map*. ++ +image::media/new_group_map.png[New Library Group Map] ++ +. Choose a *Library Group* from the dropdown. ++ +image::media/group_map_dropdown.png[Library Group Dropdown] ++ +. Choose an Organizational Unit from the selector. ++ +image::media/group_map_ou_dropdown.png[Organizational Unit Selector] ++ +. Click *Save*. + +Repeat steps 1-4 until all desired Organizational Units are assigned to +the Library Group. + +[NOTE] +==== +Descendant Organizational Units are NOT automatically included +and each must be specifically added to the Library Group. +==== + +After all Library Groups are created and assigned, you must run autogen and restart Apache in order for the changes to be reflected. diff --git a/docs/modules/opac/assets/images/media/library_group_location_as.png b/docs/modules/opac/assets/images/media/library_group_location_as.png new file mode 100644 index 0000000000..d06aa8b8f6 Binary files /dev/null and b/docs/modules/opac/assets/images/media/library_group_location_as.png differ diff --git a/docs/modules/opac/assets/images/media/library_group_location_bs.png b/docs/modules/opac/assets/images/media/library_group_location_bs.png new file mode 100644 index 0000000000..d0023fc4bb Binary files /dev/null and b/docs/modules/opac/assets/images/media/library_group_location_bs.png differ diff --git a/docs/modules/opac/pages/using_the_public_access_catalog.adoc b/docs/modules/opac/pages/using_the_public_access_catalog.adoc index d88567b565..6435914fcc 100644 --- a/docs/modules/opac/pages/using_the_public_access_catalog.adoc +++ b/docs/modules/opac/pages/using_the_public_access_catalog.adoc @@ -250,6 +250,40 @@ might require it, using symbolic operators as follows: | NOT | `-`_term_ | `a -b` |================================= +[[library_groups]] +== Library Groups in the OPAC == + +indexterm:[Library Groups] + +To configure Library Groups, please see the xref:admin:library_groups_admin.adoc[Library Groups Administration] documentation. + +Screenshots for the below are taken from the Bootstrap OPAC (BOOPAC) but +Library Groups are also available in the Template Toolkit OPAC (TPAC). + +The *Library* dropdown includes Library Groups as well as the Depth +Selector. + +Library Groups location on the Basic Search page: + +image::media/library_group_location_bs.png[Library Groups in Basic Search] + +On the Advanced Search page, Library Groups as well as Copy Location +Groups and the Depth Selector are gathered into a dropdown labelled +*Where*, and this can be seen below the Search Library dropdown: + +image::media/library_group_location_as.png[Library Groups in Advanced Search] + +The motivation for collecting these elements into a new dropdown is that +they are secondary or subordinate to the search location -- the +organizational unit tells us what location groups, library groups, and +depths are relevant or make sense -- and are mutually exclusive among +each other. + +If a library is using the locg parameter (or equivalent), and there is +no other search context, the Where dropdown will rely on locg (or +equivalent) to populate and does not dynamically update in Advanced +Search. + == Search Tips == indexterm:[search, stop words] @@ -440,6 +474,69 @@ You may also click the _Show More Details_ link at the top of the results page, next to the _Limit to available items_ check box, to view each search result's copies' individual call number, status, and shelving location. +[[did_you_mean]] +=== Did You Mean? Search Suggestions + +indexterm:[Searching,Search Suggestions] + +As of 3.7, the work for Did You Mean enables search suggestions for a search comprising a single word within a single search class. For the purposes of suggestions, a search class in Evergreen is a keyword, title, author, series, or subject. Search suggestions are available in the public catalog (both TPAC and Bootstrap versions), the Children's OPAC (KPAC), and the Angular Staff Catalog. + +Future iterations of this project are planning to add multi word, cross +class, and other search suggestion mechanisms. + +Search suggestions are based on existing bibliographic data, and are +offered for potentially correctable spelling mistakes. A new set of +tables have been added to collect bibliographic data and build an +internal dictionary of potential search suggestions. When a catalog +search meets criteria for offering suggestions, this dictionary is used +to generate the suggestions. + +The end user will be shown a configurable number of suggestions, +hyperlinked to execute a new search based on that suggestion. Any search +options such as Format that were initially set will be carried over to +the new search. + +Evergreen’s existing use of search term stemming has not been altered as +a consequence of this work. + +For information on how to configure Did You Mean, please see the xref:admin_initial_setup:dym_admin.adoc[Administrator documentation]. + +=== Search Results Display + +In all cases, search suggestions will be offered for potentially +correctable spelling mistakes if a search retrieves fewer than the configured number of results; and potential suggested terms appear at +least the configured number of times within the bibliographic data. Clicking a +suggestion will execute a new search. + +==== Public Catalog (TPAC) + +Search suggestions are offered under the search bar. Clicking a +suggestion will execute a new search. In both examples below, the test +system was configured to offer 3 suggestions. + +image::media/dym_tpac.png[TPAC Search Suggestions] + +In the case of zero hits, suggestions are given both under the search +bar as well as in the search results area. + +image::media/dym_tpac_nohits.png[TPAC Search Suggestions when there are no hits] + +==== Public Catalog (Bootstrap) + +Search suggestions display in the same locations in the new Bootstrap +public catalog as they do in the TPAC. + +==== Public Catalog (KPAC) + +Search suggestions display in the right-hand sidebar next to Search +Results. + +image::media/dym_kpac.png[KPAC Search Suggestions] + +==== Staff Catalog + +Search suggestions in the Staff Catalog appear at the bottom of the +search area. === Viewing a record === @@ -452,6 +549,49 @@ options for placing holds, add to my list, and print/email. image::media/catalogue-8.png[catalogue-8] image::media/catalogue-8a.png[catalogue-8a] +[[geosort]] +==== Sort by Geographic Proximity + +indexterm:[Geographic Sort,Search Results,Searching] + +The sort by geographic proximity feature allows library patrons to sort +holdings within a bibliographic record by geographic distance. This +feature requires a 3rd party geographic location service in order to +function. Each Evergreen instance will need to secure its own geographic +location service. For more information on setting up this feature, please see the xref:admin_initial_setup:geosort_admin.adoc[Administrator Documentation]. + +This feature is available in both the Bootstrap and TPAC versions of the +public catalog. The screenshots are from the Bootstrap catalog. + +When a patron selects a bibliographic record, they are taken to the +record details interface. At the top of the holdings grid is a box to +enter an address or postal code. + +image::media/geosort_entry_box.png[OPAC Entry Box for Geographic Sort] + +The input box will accept several variants on a full address, but in +order to return a correct calculation there must be at least a +city/state or zipcode entry. Address entries make use of a 3rd party API +to calculate distance from the library branches and specifics about what +values are accepted will depend on your Geographic Location Services +provider. + +Enter an address or postal code in the box and click *Go*. The holdings +grid will resort to display the items owned by the closest library at +the top of the grid, with remaining libraries sorted by increasing +distance from the address entry. The distance display defaults to +kilometers but can be changed to show miles via a Library Setting. + +image::media/geosort_results_km.png[Geographic Sort Results] + +To return to the default item sort, click the *Use default item sort* +button. + +If the configured Geographic Location API is not able to resolve an +address entry, an error message will appear: + +image::media/geosort_retrieval_error.png[Geographic Sort Error] + == Details == indexterm:[search results, details] diff --git a/docs/modules/sys_admin/nav.adoc b/docs/modules/sys_admin/nav.adoc index 64da5034ab..4162da58a8 100644 --- a/docs/modules/sys_admin/nav.adoc +++ b/docs/modules/sys_admin/nav.adoc @@ -1,26 +1,27 @@ * xref:sys_admin:introduction.adoc[System Administration From the Staff Client] ** xref:admin:acquisitions_admin.adoc[Acquisitions Administration] -** xref:admin:age_hold_protection.adoc[Age hold protection] +** xref:admin:age_hold_protection.adoc[Age Hold Protection] ** xref:admin:authorities.adoc[Authorities] ** xref:admin:Best_Hold_Selection_Sort_Order.adoc[Best-Hold Selection Sort Order] ** xref:admin:booking-admin.adoc[Booking Module Administration] ** xref:admin:cn_prefixes_and_suffixes.adoc[Call Number Prefixes and Suffixes] ** xref:admin:desk_payments.adoc[Cash Reports] ** xref:admin:circulation_limit_groups.adoc[Circulation Limit Sets] -** xref:admin:accepting_credit_card_payments.adoc[Accepting Credit Card Payments] -** xref:admin:copy_statuses.adoc[Item Status] +** xref:admin:accepting_credit_card_payments.adoc[Credit Card Payments] +** xref:admin:event_definition_groups.adoc[Event Definition Groups] ** xref:admin:floating_groups.adoc[Floating Groups] -** xref:admin:MARC_Import_Remove_Fields.adoc[MARC Import Remove Fields] +** xref:admin:copy_statuses.adoc[Item Statuses] ** xref:admin:copy_tags_admin.adoc[Item Tags (Digital Bookplates)] +** xref:admin:library_groups_admin.adoc[Library Groups Administration] +** xref:admin:MARC_Import_Remove_Fields.adoc[MARC Import Remove Fields] ** xref:admin:MARC_RAD_MVF_CRA.adoc[MARC Record Attributes] +*** xref:admin:infrastructure_auth_browse.adoc[Authority Browse Infrastructure Changes] *** xref:admin:multilingual_search.adoc[Multilingual Search in Evergreen] -*** xref:admin:infrastructure_auth_browse.adoc[Infrastructure Changes to Authority Browse] *** xref:admin:virtual_index_defs.adoc[Virtual Index Definitions] ** xref:admin:Org_Unit_Proximity_Adjustments.adoc[Org Unit Proximity Adjustments] -** xref:admin:physical_char_wizard_db.adoc[Administering the Physical Characteristics Wizard] -** xref:admin:copy_locations.adoc[Administering shelving locations] -** xref:admin:permissions.adoc[User and Group Permissions] -** xref:admin:SMS_messaging.adoc[SMS Text Messaging] +** xref:admin:physical_char_wizard_db.adoc[Physical Characteristics Wizard Administration] +** xref:admin:copy_locations.adoc[Shelving Location Administration] +** xref:admin:SMS_messaging.adoc[SMS and Text Messaging] ** xref:admin:user_activity_type.adoc[User Activity Types] -** xref:admin:restrict_Z39.50_sources_by_perm_group.adoc[Z39.50 Servers] -** xref:admin:event_definition_groups.adoc[Event Definition Groups] \ No newline at end of file +** xref:admin:permissions.adoc[User and Group Permissions] +** xref:admin:restrict_Z39.50_sources_by_perm_group.adoc[Z39.50 Servers] \ No newline at end of file