From 24b17829ea732e916c1f6dad5573eceda7968252 Mon Sep 17 00:00:00 2001 From: Jillianne Presley Date: Sun, 10 Sep 2017 20:53:12 -0700 Subject: [PATCH] Docs reorg: Adding a manual about integrating Evergreen with other tools Signed-off-by: Jane Sandberg --- docs/admin/phonelist.adoc | 3 ++ docs/admin/sip_server.adoc | 3 ++ .../circulation/rfid_product_integration.adoc | 10 ++-- docs/development/data_unapi.adoc | 3 ++ docs/opac/search_form.adoc | 3 ++ docs/root_integrations.adoc | 49 +++++++++++++++++++ 6 files changed, 68 insertions(+), 3 deletions(-) create mode 100644 docs/root_integrations.adoc diff --git a/docs/admin/phonelist.adoc b/docs/admin/phonelist.adoc index 67bc53336d..a54f04234c 100644 --- a/docs/admin/phonelist.adoc +++ b/docs/admin/phonelist.adoc @@ -1,6 +1,9 @@ Phonelist.pm Module =================== +Introduction +------------ + PhoneList.pm is a mod_perl module for Apache that works with Evergreen to generate callings lists for patron holds or overdues. It outputs a csv file that can be fed into an auto-dialer script to call patrons with little diff --git a/docs/admin/sip_server.adoc b/docs/admin/sip_server.adoc index 574dc311df..9fe87caf49 100644 --- a/docs/admin/sip_server.adoc +++ b/docs/admin/sip_server.adoc @@ -1,6 +1,9 @@ SIP Server ---------- +About the SIP Protocol +~~~~~~~~~~~~~~~~~~~~~~ + indexterm:[Automated Circulation System] indexterm:[SelfCheck] indexterm:[Automated Material Handling] diff --git a/docs/circulation/rfid_product_integration.adoc b/docs/circulation/rfid_product_integration.adoc index 81ba11c3bc..65dd5f194a 100644 --- a/docs/circulation/rfid_product_integration.adoc +++ b/docs/circulation/rfid_product_integration.adoc @@ -4,10 +4,13 @@ RFID Product Integration Evergreen Integration with PV Supa GoodStuff RFID Reader -------------------------------------------------------- -This feature enables the Evergreen staff client to "talk" to the PV Supa Goodstuff RFID reader so that libraries can utilize PV Supa Goodstuff's RFID technology when checking items in and out. +Introduction +~~~~~~~~~~~~ -*Administration* +This feature enables the Evergreen staff client to "talk" to the PV Supa Goodstuff RFID reader so that libraries can utilize PV Supa Goodstuff's RFID technology when checking items in and out. +Administration +~~~~~~~~~~~~~~ To use PV Supa Goodstuff, you must add code to the Admin module that Evergreen can use to identify the reader. @@ -30,7 +33,8 @@ To use PV Supa Goodstuff, you must add code to the Admin module that Evergreen c -*Using RFID at the Circulation Desk* +Using RFID at the Circulation Desk +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RFID functionality is available in the Circulation module via the check-out interface, the check-out function in the patron account, and the check-in interface. diff --git a/docs/development/data_unapi.adoc b/docs/development/data_unapi.adoc index 2e17bd8d86..f4e8db5e93 100644 --- a/docs/development/data_unapi.adoc +++ b/docs/development/data_unapi.adoc @@ -1,6 +1,9 @@ Using UnAPI =========== +URL format +---------- + Evergreen's unAPI support includes access to many record types. For example, the following URL would fetch bib 267 in MODS32 along with holdings, volume, copy, diff --git a/docs/opac/search_form.adoc b/docs/opac/search_form.adoc index f1561da465..571172bd7f 100644 --- a/docs/opac/search_form.adoc +++ b/docs/opac/search_form.adoc @@ -1,6 +1,9 @@ Adding an Evergreen search form to a web page ============================================= +Introduction +------------ + To enable users to quickly search your Evergreen catalog, you can add a simple search form to any HTML page. The following code demonstrates how to create a quick search box suitable for the header of your web diff --git a/docs/root_integrations.adoc b/docs/root_integrations.adoc new file mode 100644 index 0000000000..4c8fbbe78e --- /dev/null +++ b/docs/root_integrations.adoc @@ -0,0 +1,49 @@ +Integrating Evergreen with Other Tools +====================================== +Documentation Interest Group +:doctype: book +:toc: +:numbered: + +Introduction +============ + +include::shared/about_this_documentation.adoc[] + +This guide describes how to integrate Evergreen with other technologies, including Web browsers, +Web sites, discovery layers, self-check machines, RFID equipment, SIP clients, auto-dialer phone +scripts, and other applications. + +Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/. + + + +include::shared/about_evergreen.adoc[] + +:leveloffset: -1 + +include::opac/opensearch.adoc[] + +:leveloffset: 0 + +include::development/data_supercat.adoc[] + +include::development/data_unapi.adoc[] + +include::admin/phonelist.adoc[] + + +include::circulation/rfid_product_integration.adoc[] + +include::opac/search_form.adoc[] + +:leveloffset: -1 + +include::admin/sip_server.adoc[] + +:leveloffset: 0 + +include::shared/attributions.adoc[] + +include::shared/end_matter.adoc[] + -- 2.43.2