X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;ds=inline;f=tools%2Fhtdocs%2FREADME.markdown;h=575fb6c16dd9d5fc282a06b09254d4af346de457;hb=f217fb237750008813b2814e70017ecdb927b7da;hp=882592b983c3d5ac3a7b628b29fd846cf8fa5f2b;hpb=e87e41ac4d90e6a4dcd979676b11dd9d04c98c27;p=mkws-moved-to-github.git
diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index 882592b..575fb6c 100644
--- a/tools/htdocs/README.markdown
+++ b/tools/htdocs/README.markdown
@@ -1,15 +1,14 @@
-% An embryonic MasterKey Widget Set
+% The MasterKey Widget Set
% Mike Taylor; Wolfram Schneider
% 10 July 2013
-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.
+Introduction
+------------
-
-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
@@ -19,11 +18,27 @@ can have MasterKey searching with minimal effort.
The following files are hosted on `mkws.indexdata.com`:
-* `mkwsStyle.css`
* `mkws.js`
-* `/libjs-pz2/pz2api.1.js`
+* `/pazpar2/js/pz2.js`
* `mkws-complete.js` -- a single file consisting of `mkws.js`,
- jQuery (which it uses) and `pz2api.1.js`
+ jQuery (which it uses), Handlebars (ditto) and `pz2.js`
+* `mkws.css`
+
+
+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
@@ -35,7 +50,7 @@ whatever makes up the application itself:
Prerequisites:
~~~
-
+
~~~
@@ -49,89 +64,37 @@ 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 */
- });
-~~~
-
-
-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
---------------------------
-
-- Multilinguality: English (default), Danish, German
-- Depends on the new pazpar2 JS library libjs-pz2/pz2api.1.js
- which will make the development of pazpar2 plugins faster and
- easier to share code between projects
-- Supports basic pazpar2 and service-proxy requests
-- Simplified HTML
-- The search page is fully configurable by a JSON object
+For much more detail, see
+[the MKWS whitepaper](whitepaper.html).
Checklist before doing a release
@@ -150,15 +113,6 @@ Checklist before doing a release
- what else?
-
-What next?
-----------
-
-Main areas of work:
-
-* Make MKWS robust to missing widgets
-* Clean up the code
-
- - -
-\(c) 2013 by IndexData ApS,
+Copyright 2013 IndexData ApS.