From: Wolfram Schneider <wosch@indexdata.dk>
Date: Thu, 20 Jun 2013 14:25:57 +0000 (+0000)
Subject: document mkws_config object
X-Git-Tag: 0.9.1~574^2~10
X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=commitdiff_plain;h=fca28c37fa4a71fdacaaaa873a549659f119afea

document mkws_config object
---

diff --git a/experiments/spclient/README b/experiments/spclient/README
index 9b3a85b..ae55df1 100644
--- a/experiments/spclient/README
+++ b/experiments/spclient/README
@@ -41,6 +41,9 @@ whatever makes up the application itself:
 
 Prerequisites:
     <link rel="stylesheet" href="mkwsStyle.css" />
+    <script type="text/javascript">
+	var mkws_config = { };
+    </script>
     <script type="text/javascript" src="http://code.jquery.com/jquery-1.10.0.min.js"></script>
     <script type="text/javascript" src="/libjs-pz2/pz2api.1.js"></script>
     <script type="text/javascript" src="mkws.js"></script>
@@ -62,6 +65,23 @@ missing. One of the TODOs is to fix it so that it doesn't try to use
 whatever is not there, and just uses what is.
 
 
+You can configure and control the client with the JavaScript mkws_config object.
+
+Here is an example of all possible options
+    <script type="text/javascript">
+        var mkws_config = {
+                use_service_proxy: false,   /* true, flase */
+                switch: true, 		    /* true, false */
+                sort_default: "relevance",  /* "relevance", "title:1", "date:0", "date:1" */
+		query_width: 50,	    /* 5..50 */
+                perpage_default: 20,	    /* 10, 20, 30, 50 */
+
+		pazpar2_url: "/pazpar2/search.pz2",   	   /* URL */
+		service_proxy_url: "/service-proxy/", 	   /* URL */
+		service_proxy_auth: "/service-proxy-auth", /* URL */
+         };
+    </script>
+
 What next?
 ----------
 
@@ -72,5 +92,3 @@ Main areas of work:
 * Make CSS prettier
 * Embed in a real, existing, site
 * Clean up the code
-
-