Docs: adding some basic info about getting data from opensearch

Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>

diff --git a/docs/development/data_opensearch.adoc b/docs/development/data_opensearch.adoc
new file mode 100644 (file)
index 0000000..102c90a
--- /dev/null
+++ b/docs/development/data_opensearch.adoc
@@ -0,0 +1,26 @@
+Using Opensearch as a developer
+===============================
+
+Introduction
+------------
+
+Evergreen responds to OpenSearch requests. This can be a good way to get
+search results delivered in a format that you prefer.
+
+Throughout this section, replace `<hostname>` with the domain or subdomain
+of your Evergreen installation to try these examples on your own system.
+
+Opensearch queries will be in the format
+`http://<hostname>/opac/extras/opensearch/1.1/-/html-full?searchTerms=item_type(r)&searchClass=keyword&count=25`
+
+In this example,
+
+* html-full is the format you would like.  html-full is a good view for troubleshooting your query.
+* searchTerms is a url-encoded search query.  You can use limiters in the `limiter(value)` format.
+For example, you can use a query like `item_lang(spa)`
+* count is the number of results per page.  The default is 10, and the maximum is 25.
+
+Other options include:
+
+* searchSort and searchSortDir, which can be used to display the results in a different order (e.g. for an RSS feed).
+

diff --git a/docs/root.adoc b/docs/root.adoc
index 09553e4..f29673a 100644 (file)
--- a/docs/root.adoc
+++ b/docs/root.adoc
@@ -540,6 +540,8 @@ include::development/data_supercat.adoc[]
 
 include::development/data_unapi.adoc[]
 
+include::development/data_opensearch.adoc[]
+
 // Return to normal title levels.
 :leveloffset: 0
 

diff --git a/docs/root_integrations.adoc b/docs/root_integrations.adoc
index 553d130..7d51c76 100644 (file)
--- a/docs/root_integrations.adoc
+++ b/docs/root_integrations.adoc
@@ -30,6 +30,8 @@ include::development/data_supercat.adoc[]
 
 include::development/data_unapi.adoc[]
 
+include::development/data_opensearch.adoc[]
+
 include::admin/phonelist.adoc[]