we are using service-proxy by default

[mkws-moved-to-github.git] / experiments / spclient / README

diff --git a/experiments/spclient/README b/experiments/spclient/README
index 5f54fb0..bcd492c 100644 (file)
--- a/experiments/spclient/README
+++ b/experiments/spclient/README
@@ -57,7 +57,7 @@ will be filled in by MKWS:
     <div id="mkwsSwitch"></div> -- switch between record and target views
     <div id="mkwsLang"></div>   -- switch between English, Danish and German
     <div id="mkwsSearch"></div> -- search box and button
-    <div id="mkwsRecords"></div> -- result list, including pager/sorting
+    <div id="mkwsResults"></div> -- result list, including pager/sorting
     <div id="mkwsTargets"></div> -- target list, including status
     <div id="mkwsStat"></div> -- summary statistics
 
@@ -71,12 +71,14 @@ 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 */
+                use_service_proxy: true,    /* true, flase: use service proxy instead pazpar2 */
                switch_menu: true,          /* true, false: show/hide Records|Targets menu */
                lang_menu: true,            /* true, false: show/hide language menu */
-               lang_display: ["en", "de", "da"], /* display languages links for given 
+               sort_menu: true,            /* true, false: show/hide sort menu */
+               perpage_menu: true,         /* true, false: show/hide perpage menu */
+               lang_display: ["en", "de", "da"], /* display languages links for given
                                                     languages, [] for all */
-               termlist_menu: true,        /* true, false: show/hide termlist menu/facets */
+               facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
                 sort_default: "relevance",  /* "relevance", "title:1", "date:0", "date:1" */
                query_width: 50,            /* 5..50 */
                 perpage_default: 20,       /* 10, 20, 30, 50 */
@@ -90,6 +92,7 @@ Here is an example of all possible options
          };
     </script>
 
+Note: the mkws_config object which must be loaded before the mkws.js and pz2api.js files.
 
 Supported Browsers
 ------------------
@@ -121,9 +124,5 @@ What next?
 ----------
 
 Main areas of work:
-* Fix cross-site issues proper
 * Make MKWS robust to missing widgets
-* Make CSS more tightly targeted at MKWS elements only
-* Make CSS prettier
-* Embed in a real, existing, site
 * Clean up the code