From e3c7d80c536af650fe1868217182d173f690cab5 Mon Sep 17 00:00:00 2001 From: Kathy Lussier Date: Thu, 5 Oct 2017 11:04:54 -0400 Subject: [PATCH] Docs: ebook api release note entry and doc changes Moved the content from ebook_transactions.adoc file to the 3.0 release notes. I also incorporated changes introduced in 3.0 into the documentation on ebook api. Signed-off-by: Kathy Lussier --- docs/RELEASE_NOTES_3_0.adoc | 36 +++++++++++++++++++++++++++++++ docs/admin/ebook_api.adoc | 24 +++++++++++++++------ docs/opac/ebook_transactions.adoc | 36 ------------------------------- 3 files changed, 54 insertions(+), 42 deletions(-) delete mode 100644 docs/opac/ebook_transactions.adoc diff --git a/docs/RELEASE_NOTES_3_0.adoc b/docs/RELEASE_NOTES_3_0.adoc index 72b8ccd38a..032545d06e 100644 --- a/docs/RELEASE_NOTES_3_0.adoc +++ b/docs/RELEASE_NOTES_3_0.adoc @@ -1012,6 +1012,42 @@ Public catalog ~~~~~~~~~~~~~~ +Electronic resources in the catalog +----------------------------------- + +Improvements to ebook API +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Evergreen now supports checking out and placing holds on +OverDrive and OneClickdigital ebook titles from within the public +catalog. This is an experimental feature. It is not recommended for production +use without careful testing. + +When ebook integration is enabled, a "Check Out E-Item" link will be +displayed when viewing an ebook title from a supported vendor in the +catalog. Clicking on the link allows the user to check out and download +that title from the vendor directly within the catalog. + +If no copies are available for the title, a "Place Hold on E-Item" link +is displayed instead, and the user may place a hold on the title. (Note +that some vendors require the user's account to have an email address +before permitting a hold.) + +My Account includes the ability to view current ebook checkouts and +holds, download already-checked-out titles, and cancel holds. + +For API integration to work, you need to request API access from the +vendor, and the vendor must have a way of authenticating your patrons. +Your Evergreen system also needs to be configured for ebook API +integration, following the instructions in the command line system +administration manual + + +This feature assumes that you are importing MARC records supplied by the +vendor into your Evergreen system, using Vandelay or some other MARC +import method. This feature does not search the vendor's online +collections or automatically import vendor records into your system; it +merely augments records that are already in Evergreen. Improvements to Bill Payment Pages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/admin/ebook_api.adoc b/docs/admin/ebook_api.adoc index 9767f8c033..21ae6118d8 100644 --- a/docs/admin/ebook_api.adoc +++ b/docs/admin/ebook_api.adoc @@ -1,14 +1,26 @@ Ebook API integration --------------------- -Evergreen 2.12 supports partial integration with third-party APIs -provided by OverDrive and OneClickdigital. When ebook API integration -is enabled, bibliographic records from these vendors that appear in your -public catalog will include vendor holdings and availability information. Also, -when a user is logged in, the public catalog dashboard and My Account interface -will include information about that user's checkouts and holds for +Evergreen supports integration with third-party APIs provided by OverDrive and +OneClickdigital. + +When ebook API integration is enabled, the following features are supported: + + * Bibliographic records from these vendors that appear in your +public catalog will include vendor holdings and availability information. + * Patrons can check out and place holds on OverDrive and OneClickdigital ebook +titles from within the public catalog. + * When a user is logged in, the public catalog dashboard and My Account +interface will include information about that user's checkouts and holds for supported vendors. +[WARNING] +-- +The ability to check out and place holds on ebook titles is an experimental +feature in 3.0. It is not recommended for production use without careful +testing. +-- + For API integration to work, you need to request API access from the vendor and configure your Evergreen system according to the instructions below. You also need to configure the new `open-ils.ebook_api` service. diff --git a/docs/opac/ebook_transactions.adoc b/docs/opac/ebook_transactions.adoc deleted file mode 100644 index 8d16d6f262..0000000000 --- a/docs/opac/ebook_transactions.adoc +++ /dev/null @@ -1,36 +0,0 @@ -Electronic resources in the catalog ------------------------------------ - -Checking out and placing holds -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Evergreen supports checking out and placing holds on -OverDrive and OneClickdigital ebook titles from within the public -catalog. This is an experimental feature. It is not recommended for production -use without careful testing. - -When ebook integration is enabled, a "Check Out E-Item" link will be -displayed when viewing an ebook title from a supported vendor in the -catalog. Clicking on the link allows the user to check out and download -that title from the vendor directly within the catalog. - -If no copies are available for the title, a "Place Hold on E-Item" link -is displayed instead, and the user may place a hold on the title. (Note -that some vendors require the user's account to have an email address -before permitting a hold.) - -My Account includes the ability to view current ebook checkouts and -holds, download already-checked-out titles, and cancel holds. - -For API integration to work, you need to request API access from the -vendor, and the vendor must have a way of authenticating your patrons. -Your Evergreen system also needs to be configured for ebook API -integration, following the instructions in the command line system -administration manual - - -This feature assumes that you are importing MARC records supplied by the -vendor into your Evergreen system, using Vandelay or some other MARC -import method. This feature does not search the vendor's online -collections or automatically import vendor records into your system; it -merely augments records that are already in Evergreen. -- 2.43.2