Remove What Next section: it's out of date, none of customers'
[mkws-moved-to-github.git] / tools / htdocs / README.markdown
index 3af9e39..def0094 100644 (file)
@@ -48,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>
+    <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 */
-       });
-~~~
-
-
 Supported Browsers
 ------------------
 
@@ -144,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>