X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2FREADME.markdown;h=49d415ddb77d088673371e41e3989ce5b0715587;hb=5b0f2c074c1fee794cdec4bca1612f704ec9bca3;hp=3af9e3918bd163f295baf124f281d999dd664bbb;hpb=04dc4065d934988bcf925996d7d30ad53950e5ee;p=mkws-moved-to-github.git

diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index 3af9e39..49d415d 100644
--- a/tools/htdocs/README.markdown
+++ b/tools/htdocs/README.markdown
@@ -25,8 +25,24 @@ The following files are hosted on `mkws.indexdata.com`:
 * `mkws.css`
 
 
-Configuring a client
---------------------
+Supported Browsers
+------------------
+
+Any modern browser will work fine. JavaScript must be enabled.
+
+* IE8 or later
+* Firefox 17 or later
+* Google Chrome 27 or later
+* Safari 6 or later
+* Opera  12 or later
+* iOS 6.x (iPhone, iPad)
+* Android 4.x
+
+Not supported: IE6, IE7
+
+
+Configuring a client (short version)
+------------------------------------
 
 The application's HTML must contains the following elements as well as
 whatever makes up the application itself:
@@ -48,111 +64,39 @@ 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>
-~~~
-
-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 */
-	});
+    <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: ["xtargets", "subject", "author"],
+                                    /* 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>
 ~~~
 
+For much more detail, see
+[the MKWS whitepaper](whitepaper.html).
 
-Supported Browsers
-------------------
-
-Any modern HTML5 browser will work fine. JavaScript must be enabled.
-
-* IE8 or later
-* Firefox 17 or later
-* Google Chrome 27 or later
-* Safari 6 or later
-* Opera  12 or later
-* iOS 6.x (iPhone, iPad)
-* Android 4.x
-
-Not supported: IE6, IE7
-
-
-New Features since jsdemo
---------------------------
-
-- Supports basic pazpar2 and service-proxy requests
-- Simplified HTML
-- The search page is fully configurable by a JSON object
-
-
-Checklist before doing a release
----------------------------------
-- open the site, e.g. http://mkws-dev.indexdata.com/index-mike.html
-- open the debug/error console in your browser (alt-cmd-J, shift-cmd-J)
-- check the language links ("de", "da", "en")
-- run a search with few, but not to few results, e.g.: freebsd
-- check "Targets" | "Records" links
-- check "Next" and "Prev" links
-- click on the first hit and display details, click on an "URL" to jump to
-  the local catalog or full text
-- limit search to a "Source"
-- limit search to an "Author"
-- sort results by "Title" and "newest"
-- 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>
+Copyright 2013 IndexData ApS. <http://indexdata.com>