an existing web-site with customised searching across multiple
sources, ranking and merging the results.
-All you need to do is pull in our JavaScript and optional stylesheet,
-then add `<div>`s to your page that have special `class` attributes. We
-do the rest.
+As much of the searching functionality as possible is hosted on
+<http://mkws.indexdata.com/> so that very simple applications such as
+<http://example.indexdata.com/simple.html> can have MasterKey
+searching with minimal effort. All you need to do is pull in our
+JavaScript and optional stylesheet, then add `<div>`s to your page
+that have special `class` attributes. We do the rest.
+
+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
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>
+ <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
<div class="mkwsSearch"></div>
<div class="mkwsResults"></div>
That's it. A complete metasearching application. Everything
else is refinement.
+Configuring a client (short version)
+------------------------------------
+
+The application's HTML must contains the following elements as well as
+whatever makes up the application itself:
+
+Prerequisites:
+
+~~~
+ <link rel="stylesheet" href="http://mkws.indexdata.com/mkws.css" />
+ <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
+~~~
+
+Then the following special `<div>`s can be added (with no content), and
+will be filled in by MKWS:
+
+* `<div id="mkwsSwitch"></div>` -- switch between record and target views
+* `<div id="mkwsLang"></div> ` -- switch between English, Danish and German
+* `<div id="mkwsSearch"></div>` -- search box and button
+* `<div id="mkwsResults"></div>` -- result list, including pager/sorting
+* `<div id="mkwsTargets"></div>` -- target list, including status
+* `<div id="mkwsStat"></div>` -- 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:
+
+~~~
+ <script type="text/javascript">
+ var mkws_config = {
+ lang_options: ["en", "de" ],
+ sort_default: "title:1"
+ };
+ </script>
+~~~
+
+For much more detail, see:
+[Embedded metasearching with the MasterKey Widget Set](mkws-manual.html)
+
Documentation
-------------
-* The <a href="README.html">README</a> -- mostly technical details.
+* This file.
+ [<a href="index.pdf">PDF version</a>]
* The <a href="mkws-manual.html">MKWS manual, including a reference section.</a>
- This is a much better introduction.
+ [<a href="mkws-manual.pdf">PDF version</a>]
+* The <a href="mkws-developer.html">MKWS developers' guide.</a>
+ [<a href="mkws-developer.pdf">PDF version</a>]
Tools
-----
A local copy of
<a href="http://handlebarsjs.com/">the Handlebars templating library</a>,
since it doesn't like to be hotlinked.
-* Local copy of `jquery-1.10.0.min.js`
-* Local copy of `jquery.json-2.4.js`
+* Local copy of <a href="jquery-1.10.0.min.js">jquery-1.10.0.min.js</a>
+* Local copy of <a href="jquery.json-2.4.js">jquery.json-2.4.js</a>
* <a href="mkws-complete.js">mkws-complete.js</a> --
A single large JavaScript file containing everything needed for
MKWS to work: the widget-set itself, the API library, and
* <a href="mkws.css">mkws.css</a> --
A stylesheet which styles only MasterKey widgets, and does not
otherwise interfere with application-site's styles.
-
+* <a href="mkws-jquery.js">mkws-jquery.js</a> --
+ An experimental jQuery plugin that provides an MKWS-based
+ metasearching applet.
Minified versions of the MKWS JavaScript files are also available:
* <a href="mkws.min.js">mkws.min.js</a>
* <a href="mkws-complete.min.js">mkws-complete.min.js</a>
-(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
---------
+### Specific versions
The links above to the various forms of the widget-set JavaScript
(<a href="mkws.js">mkws.js</a>,