X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2FREADME.markdown;h=95f03f088adff09355fd220af527cdf91bc4e1c5;hb=e1e6241171d921bdf2dddb603ef40422fe1b5519;hp=844fb12ebcdda37c54b984b02578b3535ce1349e;hpb=649d52f8b51802640873cc9dd433e8d1324901f9;p=mkws-moved-to-github.git
diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index 844fb12..95f03f0 100644
--- a/tools/htdocs/README.markdown
+++ b/tools/htdocs/README.markdown
@@ -1,38 +1,48 @@
-% 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
+------------
+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.
-How this works
---------------
-
-The goal is to make it that as much of the searching functionality as
-possible is hosted on
+As much of the searching functionality as possible is hosted on
so that very simple websites such as
can have MasterKey searching with minimal effort.
-The following files are hosted on mkws.indexdata.com:
+The following files are hosted on `mkws.indexdata.com`:
* `mkws.js`
-* `mkwsStyle.css`
-* `/libjs-pz2/pz2api.1.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`
+
-The following files make up an application:
+Supported Browsers
+------------------
-* `index.html`
-* `favicon.ico` [_optional_]
-* `robots.txt` [_optional_]
+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
-Configuring a client
---------------------
+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:
@@ -40,7 +50,7 @@ whatever makes up the application itself:
Prerequisites:
~~~
-
+
~~~
@@ -54,97 +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", /* interal 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
---------------------------
-
-- 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
-
-
-What next?
-----------
-
-Main areas of work:
-
-* Make MKWS robust to missing widgets
-* Clean up the code
+- - -
+Copyright 2013 IndexData ApS.