X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2FREADME.markdown;h=95f03f088adff09355fd220af527cdf91bc4e1c5;hb=6c2be612315d7afb929dbd1d38df7fd6de625600;hp=6701ab7cc216b08564de3b69ea292600c03bfbb2;hpb=63cac7f34c479f1891dbe399e3cff977f3d76cff;p=mkws-moved-to-github.git
diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index 6701ab7..95f03f0 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
@@ -22,15 +18,31 @@ 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
---------------------
+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:
@@ -52,111 +64,39 @@ will be filled in by MKWS:
* `
` -- target list, including status
* `` -- 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:
~~~
-
-~~~
-
-jQuery plugin
-------------------
-
-The jQuery plugin version can be used by a single line of JavaScript code:
-
-~~~
-
-~~~
-
-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 */
- });
+
~~~
+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.
+Copyright 2013 IndexData ApS.