From 037fa8ddb9434296bfbf186ee20cc5b2afc80f59 Mon Sep 17 00:00:00 2001 From: Andrea Buntz Neiman Date: Fri, 28 May 2021 14:37:13 -0400 Subject: [PATCH] docs: admin docs fixes Signed-off-by: Andrea Buntz Neiman Signed-off-by: Jason Etheridge --- .../pages/Org_Unit_Proximity_Adjustments.adoc | 2 +- docs/modules/admin/pages/audio_alerts.adoc | 7 ++++--- .../admin/pages/circing_uncataloged_materials.adoc | 13 +++++++------ docs/modules/admin/pages/ebook_api.adoc | 22 +++++++++++++++++----- docs/modules/admin/pages/ebook_api_service.adoc | 2 ++ docs/modules/admin/pages/purge_holds.adoc | 2 +- docs/modules/admin/pages/purge_user_activity.adoc | 2 +- .../admin/pages/search_settings_web_client.adoc | 7 ++++--- docs/modules/admin_initial_setup/nav.adoc | 7 ++++++- 9 files changed, 43 insertions(+), 21 deletions(-) diff --git a/docs/modules/admin/pages/Org_Unit_Proximity_Adjustments.adoc b/docs/modules/admin/pages/Org_Unit_Proximity_Adjustments.adoc index a091e78e97..23387c95ad 100644 --- a/docs/modules/admin/pages/Org_Unit_Proximity_Adjustments.adoc +++ b/docs/modules/admin/pages/Org_Unit_Proximity_Adjustments.adoc @@ -15,7 +15,7 @@ Org Unit Proximity between BR1 and BR4 = 4 Org Unit Proximity Adjustments allow libraries to customize the distances between org units, which provides more control over which libraries are looked at when targeting copies to fill a hold. Evergreen can also be configured to take Org Unit Proximity Adjustments into account during opportunistic capture through the -creation of a custom Best-Hold Selection Sort Order. See documentation xref:#best_hold_selection_sort_order[here] +creation of a custom Best-Hold Selection Sort Order. See documentation xref:admin:Best_Hold_Selection_Sort_Order[here] for more information on Best-Hold Selection Sort Order. An Org Unit Proximity Adjustment can be created to tell Evergreen which libraries to look at first for items to fill a hold or which library to look at last. This may be useful for accounting for true transit costs or physical distances between libraries. It can also be used to identify libraries that have special lending agreements or preferences. Org Unit Proximity Adjustments can be created for all holds between two org units, or they can be created for holds on specific Shelving Locations and Circulation Modifiers. diff --git a/docs/modules/admin/pages/audio_alerts.adoc b/docs/modules/admin/pages/audio_alerts.adoc index 1d02c9e410..1397aa9ac9 100644 --- a/docs/modules/admin/pages/audio_alerts.adoc +++ b/docs/modules/admin/pages/audio_alerts.adoc @@ -1,6 +1,7 @@ -== Managing audio alerts == += Managing audio alerts = +:toc: -=== Globally silencing sounds === +== Globally silencing sounds == indexterm:[audio alerts,silencing] indexterm:[nosound.wav] @@ -17,7 +18,7 @@ ln -s ../../nosound.wav by_search.wav ------------------------------------------------------------------------------ -=== Self-check interface === +== Self-check interface == indexterm:[audio alerts,self check interface] indexterm:[self check interface,audio alerts] indexterm:[audio_config.tt2] diff --git a/docs/modules/admin/pages/circing_uncataloged_materials.adoc b/docs/modules/admin/pages/circing_uncataloged_materials.adoc index 8389a83876..933c356f52 100644 --- a/docs/modules/admin/pages/circing_uncataloged_materials.adoc +++ b/docs/modules/admin/pages/circing_uncataloged_materials.adoc @@ -1,6 +1,7 @@ -== Circulating uncataloged materials == += Circulating uncataloged materials = +:toc: -=== Introduction === +== Introduction == This section discusses settings for circulating items that are not cataloged. Evergreen offers two ways to circulate an item that is not in the catalog: @@ -15,7 +16,7 @@ have no metadata, and are not represented with an item record. No fines accrue on these materials, but Evergreen does collect statistics on these circulations. -=== Pre-cataloged item settings === +== Pre-cataloged item settings == indexterm:[on-the-fly circulation] indexterm:[pre-cataloged items,routing to a different library] @@ -41,7 +42,7 @@ items. NOTE: Evergreen always sets the owning library of pre-cataloged items to be the consortium. -=== Non-cataloged item settings === +== Non-cataloged item settings == indexterm:[ephemeral items] @@ -49,7 +50,7 @@ In Evergreen, libraries may elect to create their own local non-cataloged item types. For example, you may choose to circulate non-cataloged paperbacks or magazine back-issues, but not wish to catalog them. -==== Adding a new non-cataloged type ==== +=== Adding a new non-cataloged type === . Go to Administration > Local Administration > Non-Cataloged Types Editor. . Under _Create a new non-cataloged type_, start filling out the appropriate @@ -64,7 +65,7 @@ back-issues, but not wish to catalog them. image::media/noncataloged_type_add.png[] -==== Deleting a non-cataloged type ==== +=== Deleting a non-cataloged type === . Go to Administration > Local Administration > Non-Cataloged Types Editor. . Click the _Delete_ button next to the type you wish to delete. Note that diff --git a/docs/modules/admin/pages/ebook_api.adoc b/docs/modules/admin/pages/ebook_api.adoc index adf79e8cf6..dd89280213 100644 --- a/docs/modules/admin/pages/ebook_api.adoc +++ b/docs/modules/admin/pages/ebook_api.adoc @@ -1,4 +1,5 @@ -== Ebook API integration == += Ebook API integration == +:toc: Evergreen supports integration with third-party APIs provided by OverDrive and OneClickdigital. @@ -30,13 +31,24 @@ merely augments records that are already in Evergreen. A future Evergreen release will add the ability for users to check out titles, place holds, etc., directly via the public catalog. -=== Ebook API service configuration === +== Ebook API service configuration == + This feature uses the new `open-ils.ebook_api` OpenSRF service. This service must be configured in your `opensrf.xml` and `opensrf_core.xml` config files for ebook API integration to work. See `opensrf.xml.example` and `opensrf_core.xml.example` for guidance. -=== OverDrive API integration === +The `open-ils.ebook_api` service looks up title and +patron information from specified ebook vendor APIs. + +The Evergreen catalog accesses data from this service +through OpenSRF JS bindings. + +The `OpenILS::Utils::HTTPClient` module is required +for this service. + + +== OverDrive API integration == Before enabling OverDrive API integration, you will need to request API access from OverDrive. OverDrive will provide the values to be used for the following new org unit settings: @@ -90,7 +102,7 @@ in `config.tt2`: older-style OverDrive records with the record identifier embedded in the 856 URL, you need to specify URL patterns with this setting. -=== OneClickdigital API integration === +== OneClickdigital API integration == Before enabling OneClickdigital API integration, you will need to request API access from OneClickdigital. OneClickdigital will provide the values to be used for the following new org unit settings: @@ -113,7 +125,7 @@ settings in `config.tt2`: records. Evergreen uses the patterns specified here to extract record identifiers for OneClickdigital titles. -=== Additional configuration === +== Additional configuration == Evergreen communicates with third-party vendor APIs using the new `OpenILS::Utils::HTTPClient` module. This module is configured using settings in `opensrf.xml`. The default settings should work for most diff --git a/docs/modules/admin/pages/ebook_api_service.adoc b/docs/modules/admin/pages/ebook_api_service.adoc index 6b5546f613..619bde4f10 100644 --- a/docs/modules/admin/pages/ebook_api_service.adoc +++ b/docs/modules/admin/pages/ebook_api_service.adoc @@ -9,3 +9,5 @@ through OpenSRF JS bindings. The `OpenILS::Utils::HTTPClient` module is required for this service. +See the xref:admin:ebook_api.adoc[ebook API Integration] documentation for more information. + diff --git a/docs/modules/admin/pages/purge_holds.adoc b/docs/modules/admin/pages/purge_holds.adoc index bb201cf0d8..9ee7700aac 100644 --- a/docs/modules/admin/pages/purge_holds.adoc +++ b/docs/modules/admin/pages/purge_holds.adoc @@ -1,4 +1,4 @@ -== Purging holds == += Purging holds = Similar to purging circulations one may wish to purge old (filled or canceled) hold information. This feature adds a database function and settings for doing so. diff --git a/docs/modules/admin/pages/purge_user_activity.adoc b/docs/modules/admin/pages/purge_user_activity.adoc index bd39954229..7b4ce0d179 100644 --- a/docs/modules/admin/pages/purge_user_activity.adoc +++ b/docs/modules/admin/pages/purge_user_activity.adoc @@ -1,4 +1,4 @@ -== Purge User Activity == += Purge User Activity = User activity types are now set to transient by default for new Evergreen installs. This means only the most recent activity entry per diff --git a/docs/modules/admin/pages/search_settings_web_client.adoc b/docs/modules/admin/pages/search_settings_web_client.adoc index d454ec8e57..52ce2332d4 100644 --- a/docs/modules/admin/pages/search_settings_web_client.adoc +++ b/docs/modules/admin/pages/search_settings_web_client.adoc @@ -1,6 +1,7 @@ -== Adjusting Relevance Ranking and Indexing == += Adjusting Relevance Ranking and Indexing = +[toc] -=== Metabib Class FTS Config Maps === +== Metabib Class FTS Config Maps == NOTE: These settings will apply to all libraries in your consortium. There is no way to apply these settings to @@ -33,7 +34,7 @@ only one library or branch. the Administration > Server Administration > Metabib Field FTS Config Maps screen. -=== Metabib Field FTS Config Maps === +== Metabib Field FTS Config Maps == NOTE: These settings will apply to all libraries in your consortium. There is no way to apply these settings to diff --git a/docs/modules/admin_initial_setup/nav.adoc b/docs/modules/admin_initial_setup/nav.adoc index 3e62645822..aaf169f85f 100644 --- a/docs/modules/admin_initial_setup/nav.adoc +++ b/docs/modules/admin_initial_setup/nav.adoc @@ -2,6 +2,8 @@ ** xref:admin_initial_setup:describing_your_organization.adoc[Describing your organization] ** xref:admin_initial_setup:describing_your_people.adoc[Describing your people] *** xref:admin:patron_address_by_zip_code.adoc[Patron Address City/State/County Pre-Populate by ZIP Code] +*** xref:admin:purge_user_activity.adoc[Purge User Activity] +*** xref:admin:purge_holds.adoc[Purge Holds] ** xref:admin_initial_setup:migrating_patron_data.adoc[Migrating Patron Data] ** xref:admin_initial_setup:migrating_your_data.adoc[Migrating from a legacy system] ** xref:admin_initial_setup:importing_via_staff_client.adoc[Importing materials in the staff client] @@ -13,18 +15,21 @@ ** xref:admin_initial_setup:KidsOPAC.adoc[Kid's OPAC Configuration] ** xref:admin_initial_setup:bootstrap_opac.adoc[Enabling the Experimental Bootstrap OPAC] ** xref:admin:search_interface.adoc[Designing the patron search experience] +*** xref:admin:search_settings_web_client.adoc[Adjusting Relevance Ranking and Indexing] *** xref:admin:auto_suggest_search.adoc[Auto Suggest in Catalog Search] *** xref:admin_initial_setup:dym_admin.adoc[Did You Mean? Search Suggestions] *** xref:admin_initial_setup:geosort_admin.adoc[Configuring Sort by Geographic Proximity] ** xref:admin_initial_setup:borrowing_items.adoc[Borrowing items: who, what, for how long] *** xref:admin:autorenewals.adoc[Autorenewals in Evergreen] *** xref:admin_initial_setup:hard_due_dates.adoc[Hard due dates] +*** xref:admin:circing_uncataloged_materials.adoc[Circulating Uncataloged Materials] ** xref:admin:apache_rewrite_tricks.adoc[Apache Rewrite Tricks] ** xref:admin:apache_access_handler.adoc[Apache Access Handler Perl Module] ** xref:admin_initial_setup:authentication_proxy.adoc[Authentication Proxy] -*** xref:admin_initial_setup:single_sign_on.adoc[Single Sign On] +** xref:admin_initial_setup:single_sign_on.adoc[Single Sign On] ** xref:admin:backups.adoc[Backing up your Evergreen System] ** xref:admin:ebook_api_service.adoc[ebook_api service] ** xref:admin:hold_targeter_service.adoc[hold-targeter service] ** xref:admin:phonelist.adoc[Phonelist.pm Module] ** xref:admin:sip_server.adoc[SIP Server] +** xref:admin:audio_alerts.adoc[Managing Audio Alerts] -- 2.11.0