-% Using the MasterKey Widget Set to embed metasearching functionality in any web-site
+% Embedded metasearching with the MasterKey Widget Set
% Mike Taylor
% 26 July 2013
+
Introduction
------------
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MKWS demo client</title>
- <link rel="stylesheet" href="http://mkws.indexdata.com/mkwsStyle.css" />
<script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
+ <link rel="stylesheet" href="http://mkws.indexdata.com/mkwsStyle.css" />
</head>
<body>
<div id="mkwsSearch"></div>
metasearching.
-Explanation
------------
+How the example works
+---------------------
If you know any HTML, the structure of the file will be familar to
you: the `<html>` element at the top level contains a `<head>` and a
* `mkwsSearch` -- provides the search box and button.
* `mkwsResults` -- provides the results area, including a list of
- brief records (which open out into full versions when clicked),
- paging for large results sets, facets for refining a search, sorting
- facilities, etc.
+ brief records (which open out into full versions when clicked),
+ paging for large results sets, facets for refining a search,
+ sorting facilities, etc.
* `mkwsLang` -- provides links to switch between one of several
different UI languages. By default, English, Danish and German are
provided.
-* `mkwsSwitch` --
+* `mkwsSwitch` -- provides links to switch between a view of the
+ result records and of the targets that provide them. Only
+ meaningful when `mkwsTargets` is also provided.
+
+* `mkwsTargets` -- the area where per-target information will appear
+ when selected by the link in the `mkwsSwitch` area. Of interest
+ mostly for fault diagnosis rather than for end-users.
+
+* `mkwsStat` --provides a status line summarising the statistics of
+ the various targets.
+
+To see all of these working together, just put them all into the HTML
+`<body>` like so:
+
+ <div id="mkwsSwitch"></div>
+ <div id="mkwsLang"></div>
+ <div id="mkwsSearch"></div>
+ <div id="mkwsResults"></div>
+ <div id="mkwsTargets"></div>
+ <div id="mkwsStat"></div>
+
+Configuration
+-------------
-* `mkwsTargets` --
-* `mkwsStat` --
+TODO
-### different HTML structure
+resposive resize
+
+
+Control over HTML and CSS
+-------------------------
+
+TODO
More sophisticated applications will not simply place the `<div>`s
together, but position them carefully within an existing page
Breaking up mkwsResults
-### configuration object
+overriding styles
-resposive resize
-### overriding styles
+Popup results with jQuery UI
+----------------------------
+
+TODO
+
+
+Authentication and target configuration
+---------------------------------------
+
+TODO
+
-### use jQuery popup
+Reference Guide
+---------------
-### Authentication setups
+### Configuration object
-Configuring targets
+TODO
-### Reference
+### jQuery plugin invocation
-Configuration object
+TODO
-jQuery plugin invocation
+### The structure of the HTML generated by the MKWS widgets
-The structure of the HTML generated by the MKWS widgets
+TODO
- - -
projects / mkws-moved-to-github.git / blobdiff