MKWS logo

MKWS: the MasterKey Widget Set

A minimal example

Here is a completely functional (though ugly) MKWS-based searching application:

<script type="text/javascript"
  src="http://mkws.indexdata.com/mkws-complete.js"></script>
<div id="mkwsSearch"></div>
<div id="mkwsResults"></div>

That's it. A complete metasearching application. Everything else is refinement.

Documentation

Tools

Here are the files that this web-site provides:

Minified versions of the MKWS JavaScript files are also available:

(This domain also hosts two web-service endpoints that are used by running MKWS-based applications: /service-proxy-auth is used to authenticate new sessions and /service-proxy/ is the main endpoint for searching and retrieval. But there is no need to use these directly: the widgets take care of that.)

Versions

The links above to the various forms of the widget-set JavaScript (mkws.js, mkws-complete.js, mkws.min.js and mkws-complete.min.js) are always to the current versions of those files. Applications that rely on a particular version can instead use the specific numbered versions in the releases area, for example releases/mkws-0.9.1.js.

The current version number is always in the VERSION file.

Version history is in the NEWS file.

Examples using the widget-set

It's worth viewing the source of these to see how small they are and how various things are done.

Simple examples

Advanced examples

Non-standard interfaces

Target selection

MKWS comes pre-configured to search in a set of a dozen or so open-access targets, as a proof of concept. But you'll want to use it to search your own selection of targets -- some open access, some subscription.

We can set that up for you: email us on info@indexdata.com.


Copyright (©) 2013-2014 Index Data ApS. http://indexdata.com