X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2FREADME.markdown;h=def00948d313439d95d3582f89ffeba45afa0489;hb=3d3ba152ae92cb04ea4e813fc5d71f5c0ccd9475;hp=a20557169f72581d83519f0a1e05dbd98c486a23;hpb=78aeb70793971bac2a700eb8e3679b0596da8ddf;p=mkws-moved-to-github.git

diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index a205571..def0094 100644
--- a/tools/htdocs/README.markdown
+++ b/tools/htdocs/README.markdown
@@ -1,4 +1,4 @@
-% An embryonic MasterKey Widget Set
+% The MasterKey Widget Set
 % Mike Taylor; Wolfram Schneider
 % 10 July 2013
 
@@ -6,13 +6,9 @@
 Introduction
 ------------
 
-This directory contains an embryonic MasterKey Widget Set. The initial
-version was based on the "jsdemo" application distributed with
-pazpar2, but it is now far removed from those beginnnings.
-
-
-How this works
---------------
+This is the MasterKey Widget Set. The initial version was based on the
+"jsdemo" application distributed with pazpar2, but it is now far
+removed from those beginnnings.
 
 As much of the searching functionality as possible is hosted on
 	<http://mkws.indexdata.com/>
@@ -22,11 +18,11 @@ can have MasterKey searching with minimal effort.
 
 The following files are hosted on `mkws.indexdata.com`:
 
-* `mkws.css`
 * `mkws.js`
 * `/pazpar2/js/pz2.js`
 * `mkws-complete.js` -- a single file consisting of `mkws.js`,
   jQuery (which it uses), Handlebars (ditto) and `pz2.js`
+* `mkws.css`
 
 
 Configuring a client
@@ -52,62 +48,35 @@ will be filled in by MKWS:
 * `<div id="mkwsTargets"></div>` -- target list, including status
 * `<div id="mkwsStat"></div>` -- summary statistics
 
-At present, MKWS may not work correctly if some of these are
-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 by creating an `mkws_config`
 object _before_ loading the widget-set.  Here is an example of all
 possible options:
 
 ~~~
-	<script type="text/javascript">
-	    var mkws_config = {
-		use_service_proxy: true,    /* true, flase: use service proxy instead pazpar2 */
-		show_lang: true, 	    /* true, false: show/hide language menu */
-		show_sort: true, 	    /* true, false: show/hide sort menu */
-		show_perpage: true, 	    /* true, false: show/hide perpage menu */
-		lang_options: ["en", "de", "da"], /* display languages links for given
-						     languages, [] for all */
-		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 */
-		lang: "en",                 /* "en", "de", "da" */
-		debug_level: 0,     	/* debug level for development: 0..2 */
-
-		responsive_design_wodth: 600,    /* page reflows for devices < 600 pixels wide */
-		pazpar2_url: "/service-proxy/", 	   /* URL */
-		service_proxy_auth: "/service-proxy-auth", /* URL */
-		// TODO: language_*, perpage_options, sort_options
-	    };
-	</script>
-~~~
-
-jQuery plugin
-------------------
-
-The jQuery plugin version can be used by a single line of JavaScript code:
-
-~~~
-	<script>jQuery.pazpar2();</script>
+    <script type="text/javascript">
+      var mkws_config = {
+        use_service_proxy: true,    /* true, flase: use service proxy instead pazpar2 */
+        show_lang: true,            /* true, false: show/hide language menu */
+        show_sort: true,            /* true, false: show/hide sort menu */
+        show_perpage: true,         /* true, false: show/hide perpage menu */
+        lang_options: ["en", "de", "da"],
+                                    /* display languages links for given languages, [] for all */
+        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 */
+        lang: "en",                 /* "en", "de", "da" */
+        debug_level: 0,             /* debug level for development: 0..2 */
+
+        responsive_design_wodth: 600,    /* page reflows for devices < 600 pixels wide */
+        pazpar2_url: "/service-proxy/",            /* URL */
+        service_proxy_auth: "/service-proxy-auth", /* URL */
+        // TODO: language_*, perpage_options, sort_options
+      };
+    </script>
 ~~~
 
-put the code in your page at the position where the metasearch should occur.
-
-Here is an example of all possible options
-
-~~~
-	jQuery.pazpar2({
-	    "layout": "popup",               /* "table" [default], "div", "popup" */
-	    "id_button": "input#mkwsButton", /* submit button id in search field */
-	    "id_popup": "#mkwsPopup",        /* internal id of popup window */
-	    "width": 880,                    /* popup width, should be at least 800 */ 
-	    "height": 760                    /* popup height, should be at least 600 */
-	});
-~~~
-
-
 Supported Browsers
 ------------------
 
@@ -148,15 +117,6 @@ Checklist before doing a release
 - what else?
 
 
-
-What next?
-----------
-
-Main areas of work:
-
-* Make MKWS robust to missing widgets
-* Clean up the code
-
 - - -
 
 Copyright 2013 IndexData ApS. <http://www.indexdata.com>