% The MasterKey Widget Set
% Mike Taylor; Wolfram Schneider
% 23 July 2014
Introduction
------------
This is the MasterKey Widget Set. It provides searching and other
information-related functionality which can be inserted into existing
web pages as small snippets of HTML.
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`:
* `mkws.js` (and its compressed version `mkws.min.js`)
* `/pazpar2/js/pz2.js`
* `mkws-complete.js` (and its compressed version `mkws-complete.min.js`)
-- a single file consisting of `mkws.js` together with the files it
uses: `pz2.js` jQuery, jQuery-JSON and Handlebars.
* Local copy of `jquery-1.10.0.min.js`
* Local copy of `jquery.json-2.4.js`
* Local copy of `handlebars-v1.1.2.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 (short version)
------------------------------------
The application's HTML must contains the following elements as well as
whatever makes up the application itself:
Prerequisites:
~~~
~~~
Then the following special `
`s can be added (with no content), and
will be filled in by MKWS:
* `` -- switch between record and target views
* ` ` -- switch between English, Danish and German
* `` -- search box and button
* `` -- result list, including pager/sorting
* `` -- target list, including status
* `` -- summary statistics
You can configure and control the client by creating an `mkws_config`
object before loading the widget-set. Here is an example showing how
to use options to offer a choice between English and German UI
languages, and to default to sorting by title ascending:
~~~
~~~
For much more detail, see
[the MKWS whitepaper](whitepaper.html).
- - -
Copyright 2014 IndexData ApS.