Docs reorg: Adding a manual about integrating Evergreen with other tools
authorJillianne Presley <jillianne.presley.1641@mail.linnbenton.edu>
Mon, 11 Sep 2017 03:53:12 +0000 (20:53 -0700)
committerJane Sandberg <sandbej@linnbenton.edu>
Mon, 11 Sep 2017 03:53:12 +0000 (20:53 -0700)
Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
docs/admin/phonelist.adoc
docs/admin/sip_server.adoc
docs/circulation/rfid_product_integration.adoc
docs/development/data_unapi.adoc
docs/opac/search_form.adoc
docs/root_integrations.adoc [new file with mode: 0644]

index 67bc533..a54f042 100644 (file)
@@ -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
index 574dc31..9fe87ca 100644 (file)
@@ -1,6 +1,9 @@
 SIP Server
 ----------
 
+About the SIP Protocol
+~~~~~~~~~~~~~~~~~~~~~~
+
 indexterm:[Automated Circulation System]
 indexterm:[SelfCheck]
 indexterm:[Automated Material Handling]
index 81ba11c..65dd5f1 100644 (file)
@@ -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.
 
index 2e17bd8..f4e8db5 100644 (file)
@@ -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,
index f1561da..571172b 100644 (file)
@@ -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 (file)
index 0000000..4c8fbbe
--- /dev/null
@@ -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[]
+